MouGetNumQueEl

Description

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

Syntax

#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);

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.