Difference between revisions of "DosQueryQueue (OS/2 1.x)"

From EDM2
Jump to: navigation, search
m
m
 
Line 10: Line 10:
 
==Return Code==
 
==Return Code==
 
;rc (USHORT) - return:Return code descriptions are:
 
;rc (USHORT) - return:Return code descriptions are:
* 0 NO_ERROR
+
*0 NO_ERROR
 
*337 ERROR_QUE_INVALID_HANDLE
 
*337 ERROR_QUE_INVALID_HANDLE
  
Line 43: Line 43:
 
</PRE>
 
</PRE>
  
[[Category:Dos]]
+
[[Category:Dos16]]

Latest revision as of 04:26, 26 January 2020

This call determines the number of elements in a queue.

Syntax

DosQueryQueue (QueueHandle, NumberElements)

Parameters

QueueHandle (HQUEUE) - input 
Handle of the queue to find size.
NumberElements (PUSHORT) - output 
Address of the number of entries in the queue waiting to be processed.

Return Code

rc (USHORT) - return
Return code descriptions are:
  • 0 NO_ERROR
  • 337 ERROR_QUE_INVALID_HANDLE

Remarks

Any thread of a process that has access to the queue (because of a DosCreateQueue or a DosOpenQueue request) may issue DosQueryQueue to determine the number of elements currently in the queue.

If the process that created the queue closes it before this request is issued, ERROR_QUE_INVALID_HANDLE is returned.

Bindings

C

#define INCL_DOSQUEUES

USHORT  rc = DosQueryQueue(QueueHandle, NumberElements);

HQUEUE  QueueHandle;    /* Queue handle */
PUSHORT NumberElements; /* Size of the queue (returned) */

USHORT  rc;             /* return code */

MASM

EXTRN  DosQueryQueue:FAR
INCL_DOSQUEUES      EQU 1

PUSH   WORD    QueueHandle    ;Queue handle
PUSH@  WORD    NumberElements ;Size of the queue (returned)
CALL   DosQueryQueue

Returns WORD