$EcbTest: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
|||
| Line 1: | Line 1: | ||
< | <p> | ||
< | <var>$EcbTest</var> checks an Event Control Block (ECB) to see if it is posted</p> | ||
<p class="code">$ | ==Syntax== | ||
<p class="code">$EcbTest(ECB-number | '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>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>CPQZ is a named ECB used by the NonStop/204 facility to automatically post an extended quiesce. See the Rocket <var class="product">Model 204</var> System Manager's Guide for an explanation of the facility. To use CPQZ, you need not set the NECBS parameter. CPQZ can be expressed as a literal, a %variable, or a field name. </li> | <li>CPQZ is a named ECB used by the NonStop/204 facility to automatically post an extended quiesce. See the Rocket <var class="product">Model 204</var> System Manager's Guide for an explanation of the facility. To use CPQZ, you need not set the NECBS parameter. CPQZ can be expressed as a literal, a %variable, or a field name. </li> | ||
<li>QZSIG is a named ECB used by the NonStop/204 facility to signal when an external backup is completed. See the Rocket <var class="product">Model 204</var> System Manager's Guide for an explanation of the facility. To use QZSIG, you need not set the NECBS parameter. QZSIG can be expressed as a literal, a %variable, or a field name. </li> | <li>QZSIG is a named ECB used by the NonStop/204 facility to signal when an external backup is completed. See the Rocket <var class="product">Model 204</var> System Manager's Guide for an explanation of the facility. To use QZSIG, you need not set the NECBS parameter. QZSIG can be expressed as a literal, a %variable, or a field name. </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> | ||
[[Category:SOUL $functions]] | [[Category:SOUL $functions]] | ||
Revision as of 19:16, 8 September 2014
$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 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. See the Rocket Model 204 System Manager's Guide for an explanation of the facility. 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. See the Rocket Model 204 System Manager's Guide for an explanation of the facility. 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)