en:docs:fapi:moureadeventque

Differences

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

Link to this comparison view

Next revision
Previous revision
en:docs:fapi:moureadeventque [2021/10/06 14:23] – created prokusheven:docs:fapi:moureadeventque [2021/11/04 13:14] (current) prokushev
Line 1: Line 1:
 +{{page>en:templates:fapiint}}
 +
 +
 +====== MouReadEventQue ======
 +
 This call reads an event from the mouse device FIFO event queue, and places it in a structure provided by the application. This call reads an event from the mouse device FIFO event queue, and places it in a structure provided by the application.
  
-==Syntax==+===== Syntax ===== 
 +<code c>
  MouReadEventQue (Buffer, ReadType, DeviceHandle)  MouReadEventQue (Buffer, ReadType, DeviceHandle)
 +</code>
  
-==Parameters== +===== Parameters =====
-;Buffer (P[[MOUEVENTINFO]]) - output: Address of the status of the mouse event queue. +
-;DeviceHandle (HMOU) - input :  Handle of the mouse device from a previous MouOpen.+
  
-==Return Code== +  * Buffer ([[PMOUEVENTINFO]]) - output: Address of the status of the mouse event queue. 
-;rc (USHORT) - return:Return code descriptions are: +  * DeviceHandle ([[HMOU]]) - input :  Handle of the mouse device from a previous MouOpen. 
-* 0   NO_ERROR + 
-* 385 ERROR_MOUSE_NO_DEVICE +===== Return Code ===== 
-* 387 ERROR_MOUSE_INV_PARMS + 
-* 393 ERROR_MOUSE_NO_DATA +rc ([[USHORT]]) - return:Return code descriptions are: 
-* 466 ERROR_MOU_DETACHED + 
-* 501 ERROR_MOUSE_NO_CONSOLE +  * 0   NO_ERROR 
-* 505 ERROR_MOU_EXTENDED_SG+  * 385 ERROR_MOUSE_NO_DEVICE 
 +  * 387 ERROR_MOUSE_INV_PARMS 
 +  * 393 ERROR_MOUSE_NO_DATA 
 +  * 466 ERROR_MOU_DETACHED 
 +  * 501 ERROR_MOUSE_NO_CONSOLE 
 +  * 505 ERROR_MOU_EXTENDED_SG 
 + 
 +===== Remarks =====
  
-==Remarks== 
 The types of queued events are directly affected by the current value of the Mouse EventMask. MouSetEventMask is used to indicate the types of events desired, and MouGetEventMask is used to query the current value of the mask. Refer to these functions for further explanation of the masking of events. The types of queued events are directly affected by the current value of the Mouse EventMask. MouSetEventMask is used to indicate the types of events desired, and MouGetEventMask is used to query the current value of the mask. Refer to these functions for further explanation of the masking of events.
  
Line 31: Line 42:
 The Row and Column fields in the Buffer Parameter may contain either absolute display coordinates or relative mouse motion in mickeys. See [[MouSetDevStatus]] for additional information. The Row and Column fields in the Buffer Parameter may contain either absolute display coordinates or relative mouse motion in mickeys. See [[MouSetDevStatus]] for additional information.
  
-==Bindings== +===== Bindings ===== 
-===C=== + 
-<PRE>+====C==== 
 +<code c>
 typedef struct _MOUEVENTINFO { /* mouev */ typedef struct _MOUEVENTINFO { /* mouev */
   USHORT fs;                   /* State of mouse at time event was reported */   USHORT fs;                   /* State of mouse at time event was reported */
Line 50: Line 62:
  
 USHORT           rc;           /* return code */ USHORT           rc;           /* return code */
-</PRE>+</code>
  
-===MASM=== +====MASM==== 
-<PRE>+<code asm>
 MOUEVENTINFO struc MOUEVENTINFO struc
   mouev_fs   dw  ?  ;State of mouse at time event was reported   mouev_fs   dw  ?  ;State of mouse at time event was reported
Line 70: Line 82:
  
 Returns WORD Returns WORD
-</PRE>+</code>
  
-[[Category:Mou]]+{{page>en:templates:fapi}}