VioGetCurPos: Difference between revisions

Latest revision as of 10:56, 5 March 2020

Returns the coordinates of the cursor.

Syntax

VioGetCurPos(Row, Column, VioHandle)

Parameters

Row (PULONG) - output: Row return data.; Address of the current row position of the cursor, where 0 is the top row.
Column (PUSHORT) - output: Column return data.; The address of the current column position of the cursor, where 0 is the leftmost column.
VioHandle (HVIO) - input: Presentation-space handle.; This must be zero, unless the caller is a Presentation Manager application; in this case, it must be the value returned by VioCreatePS.

Return Code

rc (APIRET) - returns: VioGetCurPos 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 coordinates of the cursor.
 ==Syntax==
-<PRE>
+ VioGetCurPos(Row, Column, VioHandle)
-#define INCL_VIO
-#include <os2.h>
-PULONG     Row;        /*  Row return data. */
-PUSHORT    Column;     /*  Column return data. */
-HVIO       VioHandle;  /*  Presentation-space handle. */
-APIRET     rc;         /*  Return code. */
-rc = VioGetCurPos(Row, Column, VioHandle);
-</PRE>
 ==Parameters==
-; Row (PULONG) - output :  Row return data.
+;Row (PULONG) - output:  Row return data.
-Address of the current row position of the cursor, where 0 is the top row.
+:Address of the current row position of the cursor, where 0 is the top row.
+;Column (PUSHORT) - output: Column return data.
-; Column (PUSHORT) - output : Column return data.
+:The address of the current column position of the cursor, where 0 is the leftmost column.
-The address of the current column position of the cursor, where 0 is the leftmost column.
+;VioHandle (HVIO) - input: Presentation-space handle.
+:This must be zero, unless the caller is a Presentation Manager application; in this case, it must be the value returned by [[VioCreatePS]].
-; VioHandle (HVIO) - input : Presentation-space handle.
-This must be zero, 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:VioGetCurPos returns one of the following values:
+*0 NO_ERROR
-VioGetCurPos 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]]