en:docs:fapi:mougetscalefact

Differences

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

Link to this comparison view

Next revision
Previous revision
en:docs:fapi:mougetscalefact [2021/10/06 14:24] – created prokusheven:docs:fapi:mougetscalefact [2021/11/04 13:13] (current) prokushev
Line 1: Line 1:
 +{{page>en:templates:fapiint}}
 +
 +====== MouGetScaleFact ======
 +
 This call returns a pair of 1-word scaling factors for the current mouse device. This call returns a pair of 1-word scaling factors for the current mouse device.
  
-==Syntax==+===== Syntax ===== 
  MouGetScaleFact (ScaleStruct, DeviceHandle)  MouGetScaleFact (ScaleStruct, DeviceHandle)
  
-==Parameters== +===== Parameters =====
-;ScaleStruct (P[[SCALEFACT]]) - output: Address of the control block structure that contains the current row and column coordinate scaling factors. +
-:See [[MouSetScaleFact (OS/2 1.x)|MouSetScaleFact]] for more information. +
-;DeviceHandle (HMOU) - input: Contains the handle of the mouse device obtained from a previous MouOpen.+
  
-==Return Code== +  * ScaleStruct (P[[SCALEFACT]]) - output: Address of the control block structure that contains the current row and column coordinate scaling factors. 
-;rc (USHORT) - return:Return code descriptions are: + 
-*0 NO_ERROR +See [[MouSetScaleFact]] for more information. 
-*385 ERROR_MOUSE_NO_DEVICE + 
-*466 ERROR_MOU_DETACHED +  * DeviceHandle (HMOU) - input: Contains the handle of the mouse device obtained from a previous MouOpen. 
-*501 ERROR_MOUSE_NO_CONSOLE + 
-*505 ERROR_MOU_EXTENDED_SG+===== Return Code ===== 
 + 
 +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 units of the scale factor depend on the mode of the display screen for the session. If the screen is operating in text mode, the scaling units are relative to characters. If the screen is operating in graphics mode, the scaling units are relative to pels. The units of the scale factor depend on the mode of the display screen for the session. If the screen is operating in text mode, the scaling units are relative to characters. If the screen is operating in graphics mode, the scaling units are relative to pels.
  
-==Bindings== +===== Bindings ===== 
-===C=== + 
-<PRE>+====C==== 
 +<code c>
 typedef struct _SCALEFACT { /* mousc */ typedef struct _SCALEFACT { /* mousc */
   USHORT rowScale;          /* row scaling factor */   USHORT rowScale;          /* row scaling factor */
Line 36: Line 48:
  
 USHORT     rc;            /* return code */ USHORT     rc;            /* return code */
-</PRE>+</code>
  
-===MASM=== +====MASM==== 
-<PRE>+<code asm>
 SCALEFACT struc SCALEFACT struc
   mousc_rowScale  dw  ? ;row scaling factor   mousc_rowScale  dw  ? ;row scaling factor
Line 53: Line 65:
  
 Returns WORD Returns WORD
-</PRE>+</code> 
  
-[[Category:Mou]]+{{page>en:templates:fapi}}