en:docs:fapi:mougetnumqueel

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
en:docs:fapi:mougetnumqueel [2021/10/06 14:23] – created prokusheven:docs:fapi:mougetnumqueel [2021/11/04 13:14] (current) prokushev
Line 1: Line 1:
 +{{page>en:templates:fapiint}}
 +
 +====== MouGetNumQueEl ======
 +
 This call returns the current status for the mouse device driver event queue. This call returns the current status for the mouse device driver event queue.
  
-==Syntax==+===== Syntax ===== 
 +<code c>
  MouGetNumQueEl (QueDataRecord, DeviceHandle)  MouGetNumQueEl (QueDataRecord, DeviceHandle)
 +</code>
  
-==Parameters== +===== Parameters =====
-;QueDataRecord (PMOUQUEINFO) - output : Address of the mouse queue status structure: +
-:numqelements (USHORT) : Current number of event queue elements, in the range 0 <> value <> maxnumqelements. +
-:maxnumqelements (USHORT) : Maximum number of queue elements as specified in the QSIZE NN parameter in DEVICE=MOUSExxx.SYS statement in CONFIG.SYS. +
-;DeviceHandle (HMOU) - input : Contains the handle of the mouse device obtained from a previous MouOpen.+
  
-==Return Code== +  * QueDataRecord (PMOUQUEINFO) - output : Address of the mouse queue status structure: 
-;rc (USHORT) - return:Return code descriptions are: +    * numqelements (USHORT) : Current number of event queue elements, in the range 0 <> value <> maxnumqelements. 
-* 0    NO_ERROR +    * maxnumqelements (USHORT) : Maximum number of queue elements as specified in the QSIZE = NN parameter in DEVICE=MOUSExxx.SYS statement in CONFIG.SYS. 
-* 385  ERROR_MOUSE_NO_DEVICE +  * DeviceHandle (HMOU) - input : Contains the handle of the mouse device obtained from a previous MouOpen. 
-* 466  ERROR_MOU_DETACHED + 
-* 501  ERROR_MOUSE_NO_CONSOLE +===== Return Code ===== 
-* 505  ERROR_MOU_EXTENDED_SG+ 
 +rc (USHORT) - return:Return code descriptions are: 
 + 
 +  * 0    NO_ERROR 
 +  * 385  ERROR_MOUSE_NO_DEVICE 
 +  * 466  ERROR_MOU_DETACHED 
 +  * 501  ERROR_MOUSE_NO_CONSOLE 
 +  * 505  ERROR_MOU_EXTENDED_SG 
 + 
 +===== Remarks =====
  
-==Remarks== 
 The maxnumqelements returned by this function is established during mouse device driver configuration. See the mouse DEVICE=MOUSExxx.SYS statement in the ''IBM Operating System/2 Version 1.2 Command Reference'' for further details. The maxnumqelements returned by this function is established during mouse device driver configuration. See the mouse DEVICE=MOUSExxx.SYS statement in the ''IBM Operating System/2 Version 1.2 Command Reference'' for further details.
  
-==Bindings== +===== Bindings ===== 
-===C=== + 
-<PRE>+====C==== 
 +<code c>
 typedef struct _MOUQUEINFO {  /* mouqi */ typedef struct _MOUQUEINFO {  /* mouqi */
   USHORT cEvents;             /* current number of event queue elements */   USHORT cEvents;             /* current number of event queue elements */
Line 37: Line 48:
  
 USHORT         rc;           /* return code */ USHORT         rc;           /* return code */
-</PRE>+</code>
  
-===MASM=== +====MASM==== 
-<PRE>+<code asm>
 MOUQUEINFO struc MOUQUEINFO struc
   mouqi_cEvents    dw  ? ;current number of event queue elements   mouqi_cEvents    dw  ? ;current number of event queue elements
Line 54: Line 65:
  
 Returns WORD Returns WORD
-</PRE>+</code>
  
-[[Category:Mou]]+{{page>en:templates:fapi}}