$EcbTest: Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (remove Sys Man guide)
Line 10: Line 10:
<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 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 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>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 [[System and media recovery#Media recovery NonStop/204|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><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>
</ul>



Revision as of 12:05, 27 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)