$EcbTest: Difference between revisions

From m204wiki
Jump to navigation Jump to search
 
(2 intermediate revisions by the same user not shown)
Line 17: Line 17:
==Usage==
==Usage==
<p>
<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>
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 58: Line 58:


==Example==
==Example==
<p class="code">%rc=$Ecbtest(1)
<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: