Check EDRS Block Status (QxdaCheckEDRSBlock) API
Required Parameter Group:
| 1 | Receiver variable | Output | Char(*) |
| 2 | Length of receiver variable | Input | Binary(4) |
| 3 | Receiver variable format | Input | Char(8) |
| 4 | EDRS server system name | Input | Char(256) |
| 5 | Error code | I/O | Char(*) |
Service Program: QXDADBBK
Default Public Authority: *USE
Threadsafe: Conditional; see Usage Notes
The Check EDRS Block Status (QxdaCheckEDRSBlock) API returns information about the availability status of a server system.
Authorities and Locks
None.
Required Parameter Group
- Receiver variable
- I/O; CHAR(*)
The structure in which to return information about the availability status of the system specified. For the format of this parameter, see BLKO0100 Format.
- Length of receiver variable
- INPUT; BINARY(4)
The number of bytes that the calling program provides for the receiver variable.
- Receiver variable format
- INPUT; CHAR(8)
The format of the receiver variable being used. The possible value is:
BLKO0100 Basic structure
- EDRS server system name
- INPUT; CHAR(256)
The name of the database server system to check.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
BLKO0100 Format
The following table shows the information to pass in the BLKO0100 format. For more details about the fields in this table, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Bytes returned |
| 4 | 4 | BINARY(4) | Bytes available |
| 8 | 8 | BINARY(4) | EDRS server status |
| 12 | 12 | CHAR(256) | Backup server system name |
| 268 | 10C | BINARY(4) | Offset to job-suspension user data |
| 272 | 110 | BINARY(4) | Length of job-suspension user data |
| CHAR(*) | Job-suspension user data | ||
Field Descriptions
Backup server system name. The name of the system that is acting as the backup server system. This value will be set to blanks if the EDRS system is not blocked or switched.
Bytes available. The length of the information available to the API to return, in bytes.
Bytes returned. The actual number of bytes returned to the caller of the API.
EDRS server status. The status of the server system. The possible values are:
| 0 | QXDA_UNBLOCKED: The EDRS system is not blocked. |
| 1 | QXDA_BLOCKED: The EDRS server system is blocked. |
| 2 | QXDA_SWITCHED: The backup system is acting as the EDRS server. |
Job-suspension user data. The data associated with the block.
Length of job-suspension user data. The length of job-suspension user data returned.
Offset to job-suspension user data. The offset from the beginning of the receiver variable to the the job-suspension user data, in bytes.
Usage Notes
This function may be called from the initial thread of a job only.
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF0001 E | Error found on &1 command. |
| CPF3C1E E | Required parameter &1 omitted. |
| CPF3C90 E | Literal value cannot be changed. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
| CPFB751 E | Parameter &1 passed not correct. |
| CPFB752 E | Internal error in &1 API. |
API introduced: V4R4