Data Queue APIs--Categories - FTP Directory Listing - IBM

Retrieve Data Queue Message (QMHRDQM) API
Required Parameter Group
Receiver variable
OUTPUT; CHAR(*)
The receiver variable that receives the information requested. You can specify the size of the area to
be smaller than the format requested as long as you specify the length parameter correctly. As a
result, the API returns only the data that the area can hold.
Length of receiver variable
INPUT; BINARY(4)
The length of the receiver variable provided. The length of receiver variable parameter may be
specified up to the size of the receiver variable specified in the user program. If the length of
receiver variable parameter specified is larger than the allocated size of the receiver variable
specified in the user program, the results are not predictable. The minimum length is 8 bytes.
Format name
INPUT; CHAR(8)
The format of the data to be placed in the receiver variable. You must use the RDQM0100 format.
Qualified data queue name
INPUT; CHAR(20)
The data queue whose description is to be returned. The first 10 characters contain the data queue
name, and the second 10 characters contain the data queue library name. You can use these special
values for the library name:
*CURLIB
The job's current library
*LIBL
The library list
Note: To improve data queue performance, the data queue APIs remember addressing information
for the last data queues used. When this occurs, a specific (not *LIBL or *CURLIB) value is
provided for the library name.
Because the addressing information is saved, users of this API should be aware of the following
scenario:
If,
❍
❍
❍
then,
a job references a data queue,
the data queue is moved using the Move Object (MOVOBJ) command or renamed using the
Rename Object (RNMOBJ) command, and
a new data queue is created with the same name and library as the data queue that was
renamed or moved,
http://infocntr.rchland.ibm.com/pubs/html/as400/v4r5/ic2924/info/apis/qmhrdqm.htm (2 of 8) [10/4/1999 2:32:30 PM]