MouGetNumQueEl: Difference between revisions

Revision as of 08:45, 10 January 2017

Returns the current status for the mouse device driver event queue.

rc = MouGetNumQueEl(QueDataRecord, DeviceHandle);

QueDataRecord (PMOUQUEINFO) - output: Pointer to the mouse queue data structure.
DeviceHandle (HMOU) - input: Reserved. Must be 0.

The maximum number of queue elements returned in cmaxEvents is established during mouse device-driver configuration.

@@ Line 1: / Line 1: @@
-==Description==
 Returns the current status for the mouse device driver event queue.
 ==Syntax==
-<PRE>
+ rc = MouGetNumQueEl(QueDataRecord, DeviceHandle);
-#define INCL_MOU
-#include <os2.h>
-PMOUQUEINFO    QueDataRecord;  /*  Pointer to the mouse queue data structure. */
-HMOU           DeviceHandle;   /*  Reserved.  Must be 0. */
-APIRET         rc;             /*  Return code. */
-rc = MouGetNumQueEl(QueDataRecord, DeviceHandle);
-</PRE>
 ==Parameters==
-;  QueDataRecord (PMOUQUEINFO) - output : Pointer to the mouse queue data structure.
+;QueDataRecord (PMOUQUEINFO) - output : Pointer to the mouse queue data structure.
+;DeviceHandle (HMOU) - input : Reserved. Must be 0.
-; DeviceHandle (HMOU) - input : Reserved. Must be 0.
 ==Return Code==
- rc (APIRET) - returns
+;rc ([[APIRET]]) - returns:MouGetNumQueEl returns one of the following values:
-MouGetNumQueEl returns one of the following values:
 * 0          NO_ERROR
 * 466        ERROR_MOU_DETACHED
@@ Line 31: / Line 17: @@
 The maximum number of queue elements returned in cmaxEvents is established during mouse device-driver configuration.
-==Example Code==
+[[Category:Mou]]
-<PRE>
-</PRE>
-==Related Functions==
-*
-[[Category:The OS/2 API Project]]