The Retrieve Data Queue Info (RTVDTAQXCL) command retrieves information about a data queue. The information retrieved includes creation attributes as well as current status information.

This function is also available with command RTVDTAQINF in library VC2XCL. Any use of this alternative command name should be library qualified in case the i operating system were to use this command name in a future release.

Restrictions:

• You must have *EXECUTE authority to the library where the data queue is located.
• You must have *OBJOPR and *READ authority to the data queue.

Parameters

Data queue (DTAQ)

Specifies the qualified name of the data queue to be accessed.

This is a required parameter.

Qualifier 1: Data queue

*LIBL

The library list for the job is used.

*CURLIB

The current library for the job is used. If no current library entry exists in the library list, QGPL is used.

name

Specify the name of the library.

Number of entries (INT 4) (NBRENT)

Specifies the CL variable to return the number of current entries is use on the data queue.

The returned value will be 0 for data queues of TYPE(*DDM).

integer

Specify the name of a CL variable defined as TYPE(*INT) LEN(4).

Max length of entry (5 0) (MAXLEN)

Specifies the CL variable to return the maximum length of an entry for the data queue.

The returned value will be 0 for data queues of TYPE(*DDM).

decimal-number

Specify the name of a CL variable defined as TYPE(*DEC) LEN(5 0).

Max length of key (3 0) (MAXKEYLEN)

Specifies the CL variable to return the maximum key length of an entry for the data queue.

The returned value will be 0 for data queues of TYPE(*DDM) or for non-keyed data queues.

decimal-number

Specify the name of a CL variable defined as TYPE(*DEC) LEN(3 0).

Sender ID (LGL) (SNDRID)

Specifies the CL variable to return whether or not sender ID information is available for a data queue entry. If the CL variable is returned with a true value ('1') sender information is available. Otherwise sender information is not available.

The returned value will be 0 for data queues of TYPE(*DDM).

logical-value

Specify the name of a CL variable defined as TYPE(*LGL).

Nbr initial entries (INT 4) (NBRINTENT)

Specifies the CL variable to return the number of initial entries when the data queue was created or when storage is reclaimed for the data queue.

The returned value will be 0 for data queues of TYPE(*DDM).

integer

Specify the name of a CL variable defined as TYPE(*INT) LEN(4).

Nbr entries allocated(INT 4) (NBRENTALC)

Specifies the CL variable to return the number of currently allocated entries for the data queue.

The returned value will be 0 for data queues of TYPE(*DDM).

integer

Specify the name of a CL variable defined as TYPE(*INT) LEN(4).

Auto reclaim (LGL) (AUTORCL)

Specifies the CL variable to return whether or not storage is automatically reclaimed when no entries are currently on the data queue.

The returned value will be 0 for data queues of TYPE(*DDM).

logical-value

Specify the name of a CL variable defined as TYPE(*LGL).

Force to aux storage (LGL) (FORCE)

Specifies the CL variable to return whether or not entries are forced to auxiliary storage as entries are sent or received.

The returned value will be 0 for data queues of TYPE(*DDM).

logical-value

Specify the name of a CL variable defined as TYPE(*LGL).

Type (10) (TYPE)

Specifies the CL variable to return the type of the data queue. A value of *STD is returned for standard data queues. A value of *DDM is returned for distributed data management (DDM) data queues.

character-value

Specify the name of a CL variable defined as TYPE(*CHAR) LEN(10).

Sequence (INT 4) (SEQ)

Specifies the CL variable to return the sequence in which messages can be received or removed from the data queue. A value of 1 is returned for FIFO data queues, 2 for LIFO data queues, and 3 for keyed data queues.

The returned value will be 0 for data queues of TYPE(*DDM).

integer

Specify the name of a CL variable defined as TYPE(*INT) LEN(4).

XCL0F0C (LIB)

Specifies the CL variable to return the name of the library where the data queue is located. If *LIBL or *CURLIB is specified for the library name, this parameter is the actual name of the library.

character-value

Specify the name of a CL variable defined as TYPE(*CHAR) LEN(10).

Device description (10) (DEVD)

Specifies the CL variable to return the name of the device description associated with a DDM data queue. The special value *LOC can be returned.

The returned value will be blank for RDB type DDM data queues and local data queues.

character-value

Specify the name of a CL variable defined as TYPE(*CHAR) LEN(10).

Mode (8) (MODE)

Specifies the CL variable to return the name of the mode associated with a DDM data queue. The special value *NETATR can be returned.

The returned value will be blank for RDB type DDM data queues and local data queues.

character-value

Specify the name of a CL variable defined as TYPE(*CHAR) LEN(8).

Remote location name (8) (RMTLOCNAME)

Specifies the CL variable to return the name of the remote location associated with a DDM data queue. The special value *RDB can be returned.

The returned value will be blank for local data queues.

character-value

Specify the name of a CL variable defined as TYPE(*CHAR) LEN(10).

Local location name (8) (LCLLOCNAME)

Specifies the CL variable to return the name of the local location associated with a DDM data queue. The special values *LOC and *NETATR can be returned.

The returned value will be blank for RDB type DDM data queues and local data queues.

character-value

Specify the name of a CL variable defined as TYPE(*CHAR) LEN(10).

Remote network ID (8) (RMTNETID)

Specifies the CL variable to return the name of the remote network ID associated with a DDM data queue. The special values *LOC, *NETATR, and *NONE can be returned.

The returned value will be blank for RDB type DDM data queues and local data queues.

character-value

Specify the name of a CL variable defined as TYPE(*CHAR) LEN(8).

Remote data queue name (10) (RMTDTAQNAM)

Specifies the CL variable to return the name of the remote data queue associated with a DDM data queue.

The returned value will be blank for local data queues.

character-value

Specify the name of a CL variable defined as TYPE(*CHAR) LEN(10).

Remote data queue lib (10) (RMTDTAQLIB)

Specifies the CL variable to return the name of the remote data queue library associated with a DDM data queue. The special values *LIBL and *CURLIB can be returned.

The returned value will be blank for local data queues.

character-value

Specify the name of a CL variable defined as TYPE(*CHAR) LEN(10).

Database name (18) (RDBNAME)

Specifies the CL variable to return the name of the relational database associated with a DDM data queue.

The returned value will be blank for non-RDB type DDM data queues and local data queues.

character-value

Specify the name of a CL variable defined as TYPE(*CHAR) LEN(18).

Text 'description' (TEXT)

Specifies the CL variable to return the text description associated with a data queue.

character-value

Specify the name of a CL variable defined as TYPE(*CHAR) LEN(50).

Examples for RTVDTAQXCL

Example 1: Simple Command Example

Dcl        Var(&NbrEnt) Type(*Int)
RtvDtaQXCL DtaQ(QTEMP/TEST) NbrEnt(&NbrEnt)

This command retrieves the current number of entries on the data queue TEST in library QTEMP.

Error messages for RTVDTAQXCL

*ESCAPE Messages

XCL9002

Function did not complete. See previously listed messages related to possible user errors.

XCL9003

Function did not complete. See previously listed messages for possible cause.

XCL9004

Function did not complete. See previously listed messages for possible cause.

XCL9005

Function did not complete. Contact your service provider.