View source for $EcbTest

<p>
<var>$EcbTest</var> checks an Event Control Block (ECB) to see if it is posted</p>

==Syntax==
<p class="syntax">$EcbTest(<span class="term">ECB-number</span> | 'CPQZ' | 'QZSIG')
</p>
<p>
Where:</p>
<ul>
<li><var class="term">ECB-number</var> is a string with a numeric value from one to the <var>[[NECBS and NOECBS parameters|NECBS]]</var> parameter that identifies which ECB to test for its post status. The <var class="term">ECB-number</var> value can be expressed as a numeric literal, a %variable, or a field name.</li>

<li><var>CPQZ</var> is a named ECB used by the [[NonStop/204 facility|NonStop/204]] facility to automatically post an extended quiesce. To use CPQZ, you need not set the <var>NECBS</var> parameter. <var>CPQZ</var> can be expressed as a literal, a %variable, or a field name. </li>

<li><var>QZSIG</var> is a named ECB used by the [[NonStop/204 facility|NonStop/204]] facility to signal when an external backup is completed. To use <var>QZSIG</var>, you need not set the <var>NECBS</var> parameter. <var>QZSIG</var> can be expressed as a literal, a %variable, or a field name. </li>
</ul>

==Usage==
<p>
Use the <var>$EcbTest</var> function to obtain ECB status, posted or not, through the return code. The post code, if set by <var>[[$Post]]</var>, is accessible using the <var>[[$StatusD]]</var> function. The following return codes apply to the <var>$EcbTest</var> function:</p>
<table>
<tr class="head">
<th>Return code </th>
<th>Meaning</th>
</tr>
<tr>
<td align="right">0 </td>
<td>Not posted</td>
</tr>
<tr>
<td align="right">1 </td>
<td>Posted</td>
</tr>
<tr>
<td align="right">2</td>
<td>Bad argument specified</td>
</tr>
<tr>
<td align="right">3</td>
<td>NECBS parameter is not specified or is zero</td>
</tr>
<tr>
<td align="right">4</td>
<td>The first argument is less than one or greater than the NECBS parameter</td>
</tr>
<tr>
<td align="right">5</td>
<td>NUSERS = 1</td>
</tr>
<tr>
<td align="right">8</td>
<td>No argument specified</td>
</tr>
<tr>
<td align="right">9</td>
<td>Checkpointing inactive, if using extended quiesce named ECBs, CPQZ or QZSIG</td>
</tr>
</table>

==Example==
<p class="code">%rc=$ecbTest(1)
</p>

==See also==
The ECB-related $functions are:
<ul>
<li><var>[[$EcbDGet]]</var>
<li><var>[[$EcbDSet]]</var>
<li><var>[[$EcbTest|$EcbTest]]</var>
<li><var>[[$Post]]</var>
<li><var>[[$UnPost]]</var>
<li><var>[[$Wait]]</var>
</ul>

[[Category:SOUL $functions]]