Retrieve Message File Attributes (QMHRMFAT) API
Required Parameter Group:
| 1 | Message file information | Output | Char(*) |
| 2 | Length of message file information | Input | Binary(4) |
| 3 | Format name | Input | Char(8) |
| 4 | Qualified message file name | Input | Char(20) |
| 5 | Error code | I/O | Char(*) |
Default Public Authority: *USE
Threadsafe: No
The Retrieve Message File Attributes (QMHRMFAT) API provides information about the attributes of a message file.
Authorities and Locks
- Message file
- *USE
- Message file library
- *EXECUTE
Required Parameter Group
- Message file information
- OUTPUT; CHAR(*)
The parameter to receive the message file information. The format of the returned data is specified in the format name parameter.
- Length of message file information
- INPUT; BINARY(4)
The size of the area to contain the message information, in bytes. If the length specified is larger than the actual size of the message file information parameter, the results may not be predictable. The minimum length is 8 bytes.
- Format name
- INPUT; CHAR(8)
The format of the information to be returned. You must use the following format name:
RMFA0100 This format is described in RMFA0100 Format.
- Qualified message file name
- INPUT; CHAR(20)
The message file and the library in which the message file is located. The first 10 characters contain the message file name, and the second 10 characters contain the message file library. You can use these special values for the library name:
*CURLIB The job's current library *LIBL The library list
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
RMFA0100 Format
The following table shows the information returned in the message file information parameter for the RMFA0100 format. For a detailed description of each field, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Bytes returned |
| 4 | 4 | BINARY(4) | Bytes available |
| 8 | 8 | CHAR(10) | Message file used |
| 18 | 12 | CHAR(10) | Message file library used |
| 28 | 1C | BINARY(4) | Current storage size |
| 32 | 20 | BINARY(4) | Increment storage size |
| 36 | 24 | BINARY(4) | Number of increments |
| 40 | 28 | BINARY(4) | Maximum increments |
| 44 | 2C | BINARY(4) | Coded character set identifier (CCSID) |
| 48 | 30 | CHAR(50) | Text description |
Field Descriptions
Bytes available. The number of bytes of data available to be returned. All available data is returned if enough space is provided.
Bytes returned. The number of bytes of data returned.
Coded character set identifier (CCSID). The coded character set identifier (CCSID) associated with this message file. A special value of 65535 means that no conversions are to occur when adding or retrieving message descriptions from this message file. A special value of 65534 means to use the CCSID associated with the message description when conversions are to occur. For more information about message handler and its use of CCSIDs, see CCSID support for messages.
Current storage size. The current storage size of the message file in bytes.
Increment storage size. The number of bytes added each time the message file is increased in size.
Maximum increments. The maximum number of times the message file can be increased in size.
Message file library used. The actual library name that contains the message file.
Message file used. The name of the message file whose attributes were returned.
Number of increments. The number of times the message file has been increased in size.
Reserved. An ignored field.
Text description. Text that briefly describes the message file.
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF2401 E | Not authorized to library &1. |
| CPF2407 E | Message file &1 in &2 not found. |
| CPF2411 E | Not authorized to message file &1 in &2. |
| CPF2483 E | Message file currently in use. |
| CPF2536 E | Value &1, for the length of message queue information not valid. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C90 E | Literal value cannot be changed. |
| CPF9830 E | Cannot assign library &1. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
API introduced: V3R1