$EcbTest

$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:

• $EcbDGet
• $EcbDSet
• $EcbTest
• $Post
• $UnPost
• $Wait