DosCloseQueue (OS/2 1.x)

Legacy Function Warning
It is recommended to use a newer replacement for this function.
Replacement:
Remarks:	This page list the older version of the function for reference.

This call closes the queue in use by the requesting process.

Syntax

DosCloseQueue (QueueHandle)

Parameters

QueueHandle (HQUEUE) - input

Handle returned from a previous DosCreateQueue or DosOpenQueue call.

Return Code

rc (USHORT) - return

Return code descriptions are:

• 0 NO_ERROR
• 337 ERROR_QUE_INVALID_HANDLE

Remarks

DosCloseQueue is used to terminate further processing of a queue by the requesting process. The actions taken depend on whether the requestor is the owner or a writer of the queue. For all processes, an access count representing all DosOpenQueue calls performed is decremented. For non-owning processes, access is terminated when this count goes to zero. For owning processes, the queue (and its elements) are purged if the access count previously equaled zero. Other processes that have the queue open receive the ERROR_QUE_INVALID_HANDLE return code on their next request.

Example Code

C Binding

#define INCL_DOSQUEUES

USHORT  rc = DosCloseQueue(QueueHandle);

HQUEUE  QueueHandle;   /* Handle of queue */

USHORT  rc;            /* return code */

This example opens a queue named special.que, then closes it.

#define INCL_DOSQUEUES

#define QUE_FIFO 0
#define QUE_NAME "\\QUEUES\\special.que"

HQUEUE QueueHandle;
USHORT rc;

   if(!DosCreateQueue(&QueueHandle,        /* Queue handle */
                      QUE_FIFO,            /* Ordering to use for
                                                  elements */
                      QUE_NAME))           /* Queue name string */
      rc = DosCloseQueue(QueueHandle);     /* Queue handle */

MASM Binding

EXTRN  DosCloseQueue:FAR
INCL_DOSQUEUES      EQU 1

PUSH   WORD    QueueHandle   ;Queue handle
CALL   DosCloseQueue

Returns WORD