$EcbTest: Difference between revisions
Jump to navigation
Jump to search
(→Usage) |
|||
| (6 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
< | <p> | ||
< | <var>$EcbTest</var> checks an Event Control Block (ECB) to see if it is posted</p> | ||
<p class=" | ==Syntax== | ||
<p class="syntax">$EcbTest(<span class="term">ECB-number</span> | 'CPQZ' | 'QZSIG') | |||
</p> | </p> | ||
<p>Where:</p> | <p> | ||
Where:</p> | |||
<ul> | <ul> | ||
<li>ECB-number is a string with a numeric value from one to the NECBS parameter that identifies which ECB to test for its post status. The ECB-number can be expressed as a numeric literal, a %variable, or a field name.</li> | <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> | ||
</li> | |||
</ul> | </ul> | ||
<p>Use the $ | ==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> | <table> | ||
<tr class="head"> | <tr class="head"> | ||
| Line 53: | Line 56: | ||
</tr> | </tr> | ||
</table> | </table> | ||
<p class="code">% | ==Example== | ||
<p class="code">%rc=$ecbTest(1) | |||
</p> | </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]] | [[Category:SOUL $functions]] | ||
Latest revision as of 00:44, 28 December 2017
$EcbTest checks an Event Control Block (ECB) to see if it is posted
Syntax
$EcbTest(ECB-number | 'CPQZ' | 'QZSIG')
Where:
- ECB-number is a string with a numeric value from one to the NECBS parameter that identifies which ECB to test for its post status. The ECB-number value can be expressed as a numeric literal, a %variable, or a field name.
- CPQZ is a named ECB used by the NonStop/204 facility to automatically post an extended quiesce. To use CPQZ, you need not set the NECBS parameter. CPQZ can be expressed as a literal, a %variable, or a field name.
- QZSIG is a named ECB used by the NonStop/204 facility to signal when an external backup is completed. To use QZSIG, you need not set the NECBS parameter. QZSIG can be expressed as a literal, a %variable, or a field name.
Usage
Use the $EcbTest function to obtain ECB status, posted or not, through the return code. The post code, if set by $Post, is accessible using the $StatusD function. The following return codes apply to the $EcbTest function:
| Return code | Meaning |
|---|---|
| 0 | Not posted |
| 1 | Posted |
| 2 | Bad argument specified |
| 3 | NECBS parameter is not specified or is zero |
| 4 | The first argument is less than one or greater than the NECBS parameter |
| 5 | NUSERS = 1 |
| 8 | No argument specified |
| 9 | Checkpointing inactive, if using extended quiesce named ECBs, CPQZ or QZSIG |
Example
%rc=$ecbTest(1)
See also
The ECB-related $functions are: