en:docs:fapi:mousetptrpos

Differences

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

Link to this comparison view

Next revision		Previous revision
en:docs:fapi:mousetptrpos [2021/10/07 13:53] – created prokusheven:docs:fapi:mousetptrpos [2021/11/04 13:05] (current) – prokushev
Line 1: Line 1:
-{{Legacy +{{page>en:templates:fapiint}} 
-|RepFunc=[[MouSetPtrPos]] + 
-|Remarks=This page list the older version of the function for reference. +====== MouSetPtrPos ====== 
-}}+
 This call directs the mouse driver to set a new row and column coordinate position for the mouse pointer. This call directs the mouse driver to set a new row and column coordinate position for the mouse pointer.
  
-==Syntax==+===== Syntax ===== 
 +<code c>
  MouSetPtrPos (PtrPos, DeviceHandle)  MouSetPtrPos (PtrPos, DeviceHandle)
 +</code>
  
-==Parameters== +===== Parameters ===== 
-;PtrPos (PPTRLOC) - input : Address of the mouse pointer position structure: + 
-:pointerrow (USHORT) : New pointer row coordinate (pels or characters). +  * PtrPos (PPTRLOC) - input : Address of the mouse pointer position structure: 
-:pointercol (USHORT) : New pointer column coordinate (pels or characters). +    * pointerrow (USHORT) : New pointer row coordinate (pels or characters). 
-;DeviceHandle (HMOU) - input : Handle of the mouse device from a previous MouOpen.+    * pointercol (USHORT) : New pointer column coordinate (pels or characters). 
 +  * DeviceHandle (HMOU) - input : Handle of the mouse device from a previous MouOpen. 
 + 
 +===== Return Code ===== 
 + 
 +rc (USHORT) - return
  
-==Return Code== 
- rc (USHORT) - return 
 Return code descriptions are: Return code descriptions are:
-* 0          NO_ERROR  
-* 385        ERROR_MOUSE_NO_DEVICE  
-* 387        ERROR_MOUSE_INV_PARMS  
-* 466        ERROR_MOU_DETACHED  
-* 501        ERROR_MOUSE_NO_CONSOLE  
-* 505        ERROR_MOU_EXTENDED_SG 
  
-==Remarks==+  * 0          NO_ERROR  
 +  * 385        ERROR_MOUSE_NO_DEVICE  
 +  * 387        ERROR_MOUSE_INV_PARMS  
 +  * 466        ERROR_MOU_DETACHED  
 +  * 501        ERROR_MOUSE_NO_CONSOLE  
 +  * 505        ERROR_MOU_EXTENDED_SG 
 + 
 +===== Remarks ===== 
 The application must ensure that the coordinate position specified conforms to the current display mode orientation for the session. Pel values must be used for graphics modes and character values for text modes. The application must ensure that the coordinate position specified conforms to the current display mode orientation for the session. Pel values must be used for graphics modes and character values for text modes.
  
 This function has no effect on the display's current collision area definition as specified by the MouDrawPtr call. If the mouse pointer image is directed into a defined collision area, the pointer image is not drawn until either the pointer is moved outside the collision area or the collision area is released by the MouDrawPtr call.  This function has no effect on the display's current collision area definition as specified by the MouDrawPtr call. If the mouse pointer image is directed into a defined collision area, the pointer image is not drawn until either the pointer is moved outside the collision area or the collision area is released by the MouDrawPtr call. 
  
-==Bindings== +===== Bindings ===== 
-===C=== + 
-<PRE>+====C==== 
 +<code c>
 typedef struct _PTRLOC {  /* moupl */ typedef struct _PTRLOC {  /* moupl */
   USHORT row;             /* pointer row coordinate screen position */   USHORT row;             /* pointer row coordinate screen position */
Line 45: Line 53:
  
 USHORT           rc;            /* return code */ USHORT           rc;            /* return code */
-</PRE>+</code>
  
-===MASM=== +====MASM==== 
-<PRE>+<code asm>
 PTRLOC  struc PTRLOC  struc
   moupl_row  dw  ? ;pointer row coordinate screen position   moupl_row  dw  ? ;pointer row coordinate screen position
Line 62: Line 70:
  
 Returns WORD Returns WORD
-</PRE>+</code> 
 + 
 +{{page>en:templates:fapi}}
  
-[[Category:Mou]]