Previous Topic: Queue RecordsNext Topic: GET QUEUE


DELETE QUEUE

Purpose

Deletes a queue or queue record.

Syntax

►►─── DELETE QUEUE ────┬────────────────┬───────────┬─ ALL ───────┬───────────►
                       └─ ID queue-id ──┘           └─ CURRENT ◄ ─┘

 ►───┬────────────────────┬─────── . ─────────────────────────────────────────►◄
     └─ error-expression ─┘

Parameters

ID queue-id

Specifies the queue or queue record associated with queue-id to be deleted.

Queue-id is the name of a variable data field that contains a queue id or the 1- to 16-character id itself, enclosed in single quotation marks.

If queue-id is not specified, a null queue id (that is, 16 blanks) is assumed.

ALL

Deletes all records, including the queue header record, in the queue specified by queue-id.

CURRENT

Deletes the record that is current of queue for the requesting task.

CURRENT is the default when you specify neither CURRENT or ALL.

error-expression

Specifies the status codes that are returned to the dialog.

Usage

Considerations

If autostatus is not in use, a dialog's error-status field indicates the outcome of a DELETE QUEUE command:

Status Code

Meaning

0000

The request was executed successfully

4404

The requested header record cannot be found

4405

The requested queue record cannot be found

4406

Currency was not established for the object queue record

4407

An I/O error occurred during processing

4431

The CA ADS internal parameter list was invalid

Example

The following example illustrates the use of the DELETE QUEUE command to delete the current record from queue CUSTQ:

DELETE QUEUE ID 'CUSTQ'.

More information:

Error Handling