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

Retrieve Data Queue Description (QMHQRDQD) API
Retrieve Data Queue Description (QMHQRDQD) API
Required Parameter Group:
1 Receiver variable Output Char(*)
2 Length of receiver variable Input Binary(4)
3 Format name Input Char(8)
4 Qualified data queue name Input Char(20)
Threadsafe: Yes
The Retrieve Data Queue Description (QMHQRDQD) API retrieves the description and attributes of a
data queue. Examples include the number of entries currently on the data queue, the text description of the
data queue, whether the queue includes sender ID information, and whether the data queue is keyed.
The attributes of a distributed data management (DDM) data queue can be retrieved with this API.
Authorities and Locks
Data Queue Authority
*OBJOPR and *READ
Data Queue Library Authority
*EXECUTE
Data Queue Lock
*EXCLRD
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
http://infocntr.rchland.ibm.com/pubs/html/as400/v4r5/ic2924/info/apis/qmhqrdqd.htm (1 of 7) [10/4/1999 2:32:25 PM]