Closes a queue.
QUEUE_CLOSE(queueId, rc<, attribs>);
When invoked on a queueId, QUEUE_CLOSE closes
the queue. The queueId is no longer open and no subsequent messaging
can occur on this queueId.
If an error or a warning condition is encountered during
the close, a non-zero return code is returned in the rc parameter.
Use the SYSMSG() function to print the message that is associated with the
The following optional attribs may be specified
on the close:
- This attribute indicates that the queue
will not be purged from memory. Its purpose is to allow temporary queues a
way to survive an initial close, thereby preserving the queue for the life
of the DOMAIN server without having to back messages to disk.
- This attribute causes a permanent dynamic
queue to be deleted if no messages reside on the queue. If messages still
exist on the queue, the queue is closed, but a warning is returned to designate
that the queue was not deleted as intended. If you use this attribute to close
an administrator pre-defined queue, a warning is returned because these types
of queues can only be deleted by an administrator using PROC ADMIN. This attribute
is ignored when closing temporary queues because they are automatically deleted
when the creating instance closes it.
- This attribute behaves exactly as the DELETE
attribute does but there is one difference. DELETE_PURGE causes a permanent
dynamic queue to be deleted even if messages remain on the queue.
Copyright 1999 by SAS Institute Inc., Cary, NC, USA. All rights reserved.