MouGetThreshold: Difference between revisions

Revision as of 23:14, 23 December 2016

Returns the current threshold values.

Syntax

#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);

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

MouSetThreshold

@@ Line 1: / Line 1: @@
-==Description==
 Returns the current threshold values.
@@ Line 15: / Line 14: @@
 ==Parameters==
-;  Threshold (PTHRESHOLD) - input : Pointer threshold structure.
+;Threshold (PTHRESHOLD) - input : Pointer threshold structure.
-Address of the control block structure that contains the threshold structure.
+:Address of the control block structure that contains the threshold structure.
+;DeviceHandle (HMOU) - input : Reserved. Must be 0.
-; DeviceHandle (HMOU) - input : Reserved. Must be 0.
 ==Return Code==
   rc (APIRET) - returns
 MouGetThreshold returns one of the following values:
+* 0          NO_ERROR
-* 0          NO_ERROR
+* 387        ERROR_MOUSE_INV_PARMS
-* 387        ERROR_MOUSE_INV_PARMS
+* 466        ERROR_MOU_DETACHED
-* 466        ERROR_MOU_DETACHED
 * 501        ERROR_MOUSE_NO_CONSOLE
-==Remarks==
-==Example Code==
-<PRE>
-</PRE>
 ==Related Functions==
-*
+* [[MouSetThreshold]]
-[[Category:The OS/2 API Project]]
+[[Category:Mou]]