VioGetCurType: Difference between revisions

Latest revision as of 21:36, 1 January 2020

Returns the cursor type.

Syntax

VioGetCurType(CursorData, VioHandle)

Parameters

CursorData (PVIOCURSORINFO) - output: Cursor characteristics.; Address of the cursor-characteristics structure.
VioHandle (HVIO) - input: Presentation-space handle.; This must be 0, unless the caller is a Presentation Manager application; in this case, it must be the value returned by VioCreatePS.

Return Code

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

0 NO_ERROR
355 ERROR_VIO_MODE
421 ERROR_VIO_INVALID_PARMS
436 ERROR_VIO_INVALID_HANDLE

@@ Line 1: / Line 1: @@
-==Description==
 Returns the cursor type.
 ==Syntax==
-<PRE>
+ VioGetCurType(CursorData, VioHandle)
-#define INCL_VIO
-#include <os2.h>
-PVIOCURSORINFO    CursorData;  /*  Cursor characteristics. */
-HVIO              VioHandle;   /*  Presentation-space handle. */
-APIRET            rc;          /*  Return code. */
-rc = VioGetCurType(CursorData, VioHandle);
-</PRE>
 ==Parameters==
-; CursorData (PVIOCURSORINFO) - output : Cursor characteristics.
+;CursorData (P[[VIOCURSORINFO]]) - output: Cursor characteristics.
-Address of the cursor-characteristics structure.
+:Address of the cursor-characteristics structure.
+;VioHandle ([[HVIO]]) - input: Presentation-space handle.
-; VioHandle (HVIO) - input : Presentation-space handle.
+:This must be 0, unless the caller is a Presentation Manager application; in this case, it must be the value returned by [[VioCreatePS]].
-This must be 0, unless the caller is a Presentation Manager application; in this case, it must be the value returned by VioCreatePS
 ==Return Code==
- rc (APIRET) - returns
+;rc (APIRET) - returns:VioGetCurType returns one of the following values:
+*0 NO_ERROR
-VioGetCurType returns one of the following values:
+*355 ERROR_VIO_MODE
+*421 ERROR_VIO_INVALID_PARMS
-* 0     NO_ERROR
+*436 ERROR_VIO_INVALID_HANDLE
-* 355   ERROR_VIO_MODE
-* 421   ERROR_VIO_INVALID_PARMS
-* 436   ERROR_VIO_INVALID_HANDLE
-==Remarks==
-==Example Code==
-<PRE>
-</PRE>
-==Related Functions==
-* [[OS2 API:CPI:
-[[Category:The OS/2 API Project]]
+[[Category:Vio]]