Retrieve Device Domain Data (QYASRTVDDD) API
Required Parameter Group:
| 1 | Data variable | Output | Char(*) |
| 2 | Length of data variable | Input | Binary(4) |
| 3 | Format name | Input | Char(8) |
| 4 | Data handle | Input | Char(32) |
| 5 | Option | Input | Binary(4) |
| 6 | Error code | I/O | Char(*) |
Default Public Authority: *EXCLUDE
Threadsafe: Yes
The Retrieve Device Domain Data (QYASRTVDDD) API retrieves data that was previously set by the Change Device Domain Data (QYASCHGDDD) API. The data could have been set by the same node or a different node that is in the same device domain of the same cluster. The structure and content of the data is completely up to the discretion of the user of the QYASCHGDDD API. The QYASCHGDDD API only ensures that the data is the same on all nodes within the device domain.
An option is provided on the QYASRTVDDD API that allows its user to prevent concurrent update by two or more nodes.
Authorities and Locks
No authority is required beyond *USE authority to the API program, QYASRTVDDD.
Required Parameter Group
- Data variable
- OUTPUT; CHAR(*)
The storage area that is to receive the data that previously was set.
- Length of data variable
- INPUT; BINARY(4)
The length of the data variable.
- Format name
- INPUT; CHAR(8)
The format of the data that is retrieved. The possible values are:
YASR0100 Data from the Change Device Domain Data (QYASCHGDDD) API.
- Data handle
- INPUT; CHAR(32)
An identifier assigned by the user of the API. The identifier is treated as hexadecimal data. The data handle must be the same as that used with the Change Device Domain Data (QYASCHGDDD) API.
- Option
- INPUT; BINARY(4)
An integer value specifying the retrieve options. Valid values are:
1 Retrieve the data and allow others to change the stored copy of the data. 2 Retrieve the data and prevent others from changing the stored copy of the data. The ensuing change of the data by the node retrieving it will once again allow all nodes to change the data. If the node becomes inactive without changing the data, other nodes will be allowed to change the data. - Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
Format Descriptions
YASR0100 Format
The following shows the order and format of the data that is returned in the receiver variable. For detailed descriptions of the fields in the table, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Bytes returned |
| 4 | 4 | BINARY(4) | Bytes available |
| 8 | 8 | CHAR(*) | Data |
Field Descriptions
Bytes available. The number of bytes of data available to be returned.
Bytes returned. The number of bytes of data that were returned.
Data. The data from the previous use of the Change Device Domain Data (QYASCHGDDD) API.
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF9821 E | Not authorized to program &1 in library &2. |
| CPF3C21 E | Format name &1 not valid. |
| CPFBA4B E | Length of operation variable not valid. |
| CPFBB59 E | Value &1 specified for option not valid. |
| CPF3CF1 E | Error code parameter not valid. |
| CPFB71C E | Device domain data was not retrieved. |
API introduced: V6R1