Jump to content

MouGetScaleFact (OS/2 1.x): Difference between revisions

From EDM2
← Older editNewer edit →
No edit summary
Ak120 (talk | contribs)
35,819 edits
mNo edit summary
Line 1: Line 1:
{{Legacy
|RepFunc=[[MouGetScaleFact]]
|Remarks=This page list the older version of the function for reference.
}}
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.


Line 9: Line 5:


==Parameters==
==Parameters==
;ScaleStruct (PSCALEFACT) - output : 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).
;ScaleStruct (P[[SCALEFACT]]) - output: Address of the control block structure that contains the current row and column coordinate scaling factors.
:rowscale (USHORT) : Row scaling factor. colscale (USHORT)
::Column scaling factor.
:See MouSetScaleFact for more information.
:See MouSetScaleFact for more information.
;DeviceHandle (HMOU) - input : Contains the handle of the mouse device obtained from a previous MouOpen.  
;DeviceHandle (HMOU) - input: Contains the handle of the mouse device obtained from a previous MouOpen.


==Return Code==
==Return Code==
rc (USHORT) - return
;rc (USHORT) - return:Return code descriptions are:
Return code descriptions are:
*0 NO_ERROR
* 0         NO_ERROR
*385 ERROR_MOUSE_NO_DEVICE
* 385       ERROR_MOUSE_NO_DEVICE  
*466 ERROR_MOU_DETACHED
* 466       ERROR_MOU_DETACHED  
*501 ERROR_MOUSE_NO_CONSOLE
* 501       ERROR_MOUSE_NO_CONSOLE  
*505 ERROR_MOU_EXTENDED_SG
* 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.


==Example Code==
==Bindings==
=== C Binding===
===C===
<PRE>
<PRE>
typedef struct _SCALEFACT {   /* mousc */
typedef struct _SCALEFACT { /* mousc */
   USHORT rowScale;           /* row scaling factor */
   USHORT rowScale;         /* row scaling factor */
   USHORT colScale;           /* column coordinate scaling factor */
   USHORT colScale;         /* column coordinate scaling factor */
} SCALEFACT;
} SCALEFACT;


Line 39: Line 32:
USHORT  rc = MouGetScaleFact(ScaleStruct, DeviceHandle);
USHORT  rc = MouGetScaleFact(ScaleStruct, DeviceHandle);


PSCALEFACT       ScaleStruct;  /* 2-word structure */
PSCALEFACT ScaleStruct;  /* 2-word structure */
HMOU             DeviceHandle;  /* Mouse device handle */
HMOU       DeviceHandle;  /* Mouse device handle */


USHORT           rc;            /* return code */
USHORT     rc;            /* return code */
</PRE>
</PRE>


===MASM Binding===
===MASM===
<PRE>
<PRE>
SCALEFACT struc
SCALEFACT struc

Revision as of 22:07, 11 December 2019

This call returns a pair of 1-word scaling factors for the current mouse device.

Syntax

MouGetScaleFact (ScaleStruct, DeviceHandle)

Parameters

ScaleStruct (PSCALEFACT) - output
Address of the control block structure that contains the current row and column coordinate scaling factors.
See MouSetScaleFact for more information.
DeviceHandle (HMOU) - input
Contains the handle of the mouse device obtained from a previous MouOpen.

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

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

C

typedef struct _SCALEFACT { /* mousc */
  USHORT rowScale;          /* row scaling factor */
  USHORT colScale;          /* column coordinate scaling factor */
} SCALEFACT;

#define INCL_MOU

USHORT  rc = MouGetScaleFact(ScaleStruct, DeviceHandle);

PSCALEFACT ScaleStruct;   /* 2-word structure */
HMOU       DeviceHandle;  /* Mouse device handle */

USHORT     rc;            /* return code */

MASM

SCALEFACT struc
  mousc_rowScale  dw  ? ;row scaling factor
  mousc_colScale  dw  ? ;column coordinate scaling factor
SCALEFACT ends

EXTRN  MouGetScaleFact:FAR
INCL_MOU            EQU 1

PUSH@  OTHER   ScaleStruct   ;2-word structure
PUSH   WORD    DeviceHandle  ;Mouse device handle
CALL   MouGetScaleFact

Returns WORD
Retrieved from "https://www.edm2.com/index.php?title=MouGetScaleFact_(OS/2_1.x)&oldid=68247"