MouGetThreshold: Difference between revisions

Latest revision as of 15:25, 29 February 2020

Returns the current threshold values.

Syntax

MouGetThreshold(Threshold, DeviceHandle);

Parameters

Threshold (PTHRESHOLD) - input: Pointer threshold structure.; Address of the control block structure that contains the threshold structure.
DeviceHandle (HMOU) - input: Reserved. Must be 0.

Return Code

rc (APIRET) - returns: MouGetThreshold returns one of the following values:

0 NO_ERROR
387 ERROR_MOUSE_INV_PARMS
466 ERROR_MOU_DETACHED
501 ERROR_MOUSE_NO_CONSOLE

Sample

#define INCL_MOU
#include <os2.h>

PTHRESHOLD    Threshold;     /*  Pointer threshold structure. */
HMOU          DeviceHandle;  /*  Reserved.  Must be 0. */
APIRET        rc;            /*  Return code. */

rc = MouGetThreshold(Threshold, DeviceHandle);

Related Functions

MouSetThreshold

@@ Line 2: / Line 2: @@
 ==Syntax==
+ MouGetThreshold(Threshold, DeviceHandle);
+==Parameters==
+;Threshold (PTHRESHOLD) - input : Pointer threshold structure.
+:Address of the control block structure that contains the threshold structure.
+;DeviceHandle (HMOU) - input : Reserved. Must be 0.
+==Return Code==
+;rc (APIRET) - returns:MouGetThreshold returns one of the following values:
+*0 NO_ERROR
+*387 ERROR_MOUSE_INV_PARMS
+*466 ERROR_MOU_DETACHED
+*501 ERROR_MOUSE_NO_CONSOLE
+==Sample==
 <PRE>
 #define INCL_MOU
@@ Line 12: / Line 27: @@
 rc = MouGetThreshold(Threshold, DeviceHandle);
 </PRE>
-==Parameters==
-;Threshold (PTHRESHOLD) - input : Pointer threshold structure.
-:Address of the control block structure that contains the threshold structure.
-;DeviceHandle (HMOU) - input : Reserved. Must be 0.
-==Return Code==
- rc (APIRET) - returns
-MouGetThreshold returns one of the following values:
-* 0          NO_ERROR
-* 387        ERROR_MOUSE_INV_PARMS
-* 466        ERROR_MOU_DETACHED
-* 501        ERROR_MOUSE_NO_CONSOLE
 ==Related Functions==