MouGetScaleFact: Difference between revisions
Created page with "==Description== Returns a pair of one-word scaling factors for the current mouse device. ==Syntax== <PRE> #define INCL_MOU #include <os2.h> PSCALEFACT ScaleStruct; /* ..." |
mNo edit summary |
||
| (2 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
Returns a pair of one-word scaling factors for the current mouse device. | Returns a pair of one-word scaling factors for the current mouse device. | ||
==Syntax== | ==Syntax== | ||
MouGetScaleFact(ScaleStruct, DeviceHandle); | |||
==Parameters== | |||
;ScaleStruct (PSCALEFACT) - output : Pointer to a control-block structure. | |||
:Address of the control-block structure that contains the current row and column coordinate scaling factors. The scaling factors must be greater than or equal to 1, and less than or equal to (32K - 1). | |||
;DeviceHandle (HMOU) - input : Reserved. Must be 0. | |||
==Return Code== | |||
rc (APIRET) - returns | |||
MouGetScaleFact returns one of the following values: | |||
*0 NO_ERROR | |||
*466 ERROR_MOU_DETACHED | |||
*501 ERROR_MOUSE_NO_CONSOLE | |||
==Sample== | |||
<PRE> | <PRE> | ||
#define INCL_MOU | #define INCL_MOU | ||
| Line 12: | Line 26: | ||
rc = MouGetScaleFact(ScaleStruct, DeviceHandle); | rc = MouGetScaleFact(ScaleStruct, DeviceHandle); | ||
</PRE> | </PRE> | ||
==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. | ||
[[Category: | [[Category:Mou]] | ||
Latest revision as of 15:25, 29 February 2020
Returns a pair of one-word scaling factors for the current mouse device.
Syntax
MouGetScaleFact(ScaleStruct, DeviceHandle);
Parameters
- ScaleStruct (PSCALEFACT) - output
- Pointer to a control-block structure.
- Address of the control-block structure that contains the current row and column coordinate scaling factors. The scaling factors must be greater than or equal to 1, and less than or equal to (32K - 1).
- DeviceHandle (HMOU) - input
- Reserved. Must be 0.
Return Code
rc (APIRET) - returns
MouGetScaleFact returns one of the following values:
- 0 NO_ERROR
- 466 ERROR_MOU_DETACHED
- 501 ERROR_MOUSE_NO_CONSOLE
Sample
#define INCL_MOU #include <os2.h> PSCALEFACT ScaleStruct; /* Pointer to a control-block structure. */ HMOU DeviceHandle; /* Reserved. Must be 0. */ APIRET rc; /* Return code. */ rc = MouGetScaleFact(ScaleStruct, DeviceHandle);
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.