Data Manipulation Language Statements › #PUTQUE—stores a queue record in the queue › #PUTQUE Parameters

#PUTQUE Parameters

RECORD=

Specifies the location of the user area that contains data to be stored in the queue record.

queue-data-location

A register that points to the area or the user-defined symbolic name of the area.

RECLEN=

Specifies the length of the data area to be stored in the queue record.

queue-data-length-register

A register that contains the length, the symbolic name of a fullword user-defined field that contains the length, or an absolute expression.

PLIST=SYSPLIST

Specifies the location of the seven-fullword storage area in which the system builds the #PUTQUE parameter list.

SYSPLIST

(Default); is the symbolic name of the storage area in which the system builds the #PUTQUE parameter list.

parameter-list-pointer

Either a register that points to the area or the symbolic name of the area.

QUEID=

Specifies the 1- to 16-character ID of the queue with which the record being stored is associated.

queue-id-pointer

A register that points to a field that contains the ID, the symbolic name of a user-defined field that contains the ID, or the ID literal enclosed in quotation marks. If a queue ID is not specified, 16 blanks are assumed.

LOC=LAST/FIRST

Specifies whether the queue record is to be placed at the beginning or end of the queue.

LAST

(Default); stores the record at the end of the queue.

FIRST

Stores the record at the beginning of the queue.

RTNQRID=

Specifies the location in the program to which the system returns the system-assigned ID of the stored queue record; the returned ID can be saved and used to retrieve or delete the queue record.

(1)

(Default); is the register to which the system returns the queue record ID.

return-queue-record-id-register

Either a register or the symbolic name of a fullword user-defined field to which the system returns the queue record ID.

COND=

Specifies whether this #PUTQUE is conditional and under what conditions control should be returned to the issuing program.

NO

(Default); specifies that the request is not conditional.

IOER

Specifies that the request is conditional. Control is returned if an I/O error occurs while processing the request.

IOERXIT=i/o-error-label

Specifies the symbolic name of the routine to which control should be returned if the #PUTQUE cannot be serviced because of an I/O error.

ERROR=error-label

Specifies the symbolic name of the routine to which control should be returned if a condition in the COND parameter occurs for which no other exit routine was coded. In this case, the ERROR parameter functions identically to IOERXIT.

RETAIN=

Specifies the amount of time, in days, that the system will retain the queue in the dictionary. At system startup, queues whose retention periods have expired are deleted automatically by the system. The retention period begins when the first record is stored in the queue.

If RETAIN is omitted, the default retention period for dynamic queues is taken.

Note: For more information on the default retention period for dynamic queues, see the CA IDMS System Generation Guide.

retention-period-register

A register that points to a field that contains the retention period, the symbolic name of a user-defined fixed-binary field that contains the retention period, or an absolute expression. The retention period must be a numeric constant in the range 0 through 255. A retention period of 255 indicates that the queue is never to be deleted automatically by the system.