$EcfStat: Difference between revisions

From m204wiki
Jump to navigation Jump to search
(Automatically generated page update)
 
m (misc cleanup)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<b>Function</b>
<p>
<p>Returns the detailed completion code from the previous EXTERNAL statement. </p>
<var>$EcfStat</var> returns the detailed completion code from the previous <var>[[External statement|External]]</var> statement. </p>
<b>Syntax</b>
 
<p>The $ECFSTAT function returns:</p>
==Syntax==
<p class="code">'RC=cccc, COMPLETION CODE=tww, REASON CODE=rrrrrrrr'
<p>
The <var>$EcfStat</var> function returns:</p>
<p class="syntax">RC=<span class="term">cccc</span>, COMPLETION CODE=<span class="term">tww</span>, REASON CODE=<span class="term">rrrrrrrr</span>
</p>
</p>
<b>Where</b>
Where:
<p>Arguments can be specified as</p>
 
<table>
<table>
<tr class="head">
<tr><th>cccc </th>
<th>Argument </th>
<th>Represents...</th>
</tr>
<tr>
<td>cccc </td>
<td>Completion code in decimal format.</td>
<td>Completion code in decimal format.</td>
</tr>
</tr>
<tr>
 
<td>t </td>
<tr><th>t </th>
<td>ABEND type, either S for SYSTEM or U for USER.</td>
<td>ABEND type, either S for SYSTEM or U for USER.</td>
</tr>
</tr>
<tr>
 
<td>ww </td>
<tr><th>ww </th>
<td>
<td>
<p>One of the following ABEND values:</p>
<p>One of the following ABEND values:</p>
<p>SYSTEM values are three hexadecimal digits followed by a blank </p>
<p>SYSTEM values are three hexadecimal digits followed by a blank </p>
<p>USER values are four decimal digits</p>
<p>USER values are four decimal digits</p>
</td>
</td></tr>
</tr>
 
<tr>
<tr><th>rrrrrrrr </th>
<td>rrrrrrrr </td>
<td>Reason code, eight hexadecimal digits</td>
<td>Reason code, eight hexadecimal digits</td>
</tr>
</tr>
</table>
</table>
<b>Usage</b>
 
<p>If ECF is not active or the user has not executed any EXTERNAL CALL, EXTERNAL DELETE, or EXTERNAL LOAD statements, a NULL string is returned.</p>
==Usage==
<p>
If ECF is not active or the user has not executed any <var>External Call</var>, <var>External Delete</var>, or <var>External Load</var> statements, a null string is returned.</p>
 
[[Category:SOUL $functions]]
[[Category:SOUL $functions]]

Latest revision as of 20:12, 20 July 2016

$EcfStat returns the detailed completion code from the previous External statement.

Syntax

The $EcfStat function returns:

RC=cccc, COMPLETION CODE=tww, REASON CODE=rrrrrrrr

Where:

cccc Completion code in decimal format.
t ABEND type, either S for SYSTEM or U for USER.
ww

One of the following ABEND values:

SYSTEM values are three hexadecimal digits followed by a blank

USER values are four decimal digits

rrrrrrrr Reason code, eight hexadecimal digits

Usage

If ECF is not active or the user has not executed any External Call, External Delete, or External Load statements, a null string is returned.