$EcbDGet

$EcbDget gets string data associated with an Event Control Block (ECB).

Syntax

$EcbDgetT(ECB-number | 'CPQZ')

Where:

• ECB-number is a string with a numeric value from one to the NECBS parameter that identifies the ECB from which to retrieve the text. 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 Media recovery NonStop/204 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. When CPQZ is specified, the value of the $EcbDget function can be non-null (except for error values) during only extended quiesce. CPQZ is internally cleared to null when the system exits extended quiesce.

Usage

When the $EcbDget function is successful, it returns your data as a text string up to 255 bytes long. If you make a coding mistake, you may receive one of the following return codes as a string.

Return code	Meaning
2	Bad argument specified
3	NECBS parameter is not specified or is zero
4	The input argument is less than one or greater than the NECBS parameter
5	NUSERS = 1
8	No argument specified
9	Checkpoints are inactive, if using extended quiesce ECB named CPQZ
12	Invalid argument CPQZ or invalid argument following QZSIG.

The $EcbDget function retrieves data set by either the $ECBDSET or $POST functions for the specified ECB.

Example

%x = $Ecbdget(17)