MouGetNumQueEl: Difference between revisions
Created page with "==Description== Returns the current status for the mouse device driver event queue. ==Syntax== <PRE> #define INCL_MOU #include <os2.h> PMOUQUEINFO QueDataRecord; /* Poi..." |
mNo edit summary |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
Returns the current status for the mouse device driver event queue. | Returns the current status for the mouse device driver event queue. | ||
==Syntax== | ==Syntax== | ||
MouGetNumQueEl(QueDataRecord, DeviceHandle) | |||
==Parameters== | ==Parameters== | ||
; | ;QueDataRecord (P[[MOUQUEINFO]]) - output: Pointer to the mouse queue data structure. | ||
;DeviceHandle (HMOU) - input: Reserved. Must be 0. | |||
; DeviceHandle (HMOU) - input : Reserved. Must be 0. | |||
==Return Code== | ==Return Code== | ||
;rc ([[APIRET]]) - returns:MouGetNumQueEl returns one of the following values: | |||
*0 NO_ERROR | |||
MouGetNumQueEl returns one of the following values: | *466 ERROR_MOU_DETACHED | ||
*501 ERROR_MOUSE_NO_CONSOLE | |||
* 0 | |||
* 466 | |||
* 501 | |||
==Remarks== | ==Remarks== | ||
The maximum number of queue elements returned in cmaxEvents is established during mouse device-driver configuration. | The maximum number of queue elements returned in cmaxEvents is established during mouse device-driver configuration. | ||
[[Category: | [[Category:Mou]] | ||
Latest revision as of 22:25, 11 December 2019
Returns the current status for the mouse device driver event queue.
Syntax
MouGetNumQueEl(QueDataRecord, DeviceHandle)
Parameters
- QueDataRecord (PMOUQUEINFO) - output
- Pointer to the mouse queue data structure.
- DeviceHandle (HMOU) - input
- Reserved. Must be 0.
Return Code
- rc (APIRET) - returns
- MouGetNumQueEl returns one of the following values:
- 0 NO_ERROR
- 466 ERROR_MOU_DETACHED
- 501 ERROR_MOUSE_NO_CONSOLE
Remarks
The maximum number of queue elements returned in cmaxEvents is established during mouse device-driver configuration.