VioSetCurPos: Difference between revisions

Latest revision as of 10:58, 5 March 2020

Sets the cursor's coordinates on the screen.

Syntax

VioSetCurPos(Row, Column, VioHandle)

Parameters

Row (ULONG) - input: New cursor row position, where 0 is the top row.
Column (USHORT) - input: New cursor column position, where 0 is the leftmost column.
VioHandle (HVIO) - input: VIO 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: VioSetCurPos returns one of the following values:

0 NO_ERROR
355 ERROR_VIO_MODE
358 ERROR_VIO_ROW
359 ERROR_VIO_COL
421 ERROR_VIO_INVALID_PARMS
436 ERROR_VIO_INVALID_HANDLE

@@ Line 1: / Line 1: @@
-==Description==
 Sets the cursor's coordinates on the screen.
 ==Syntax==
-<PRE>
+ VioSetCurPos(Row, Column, VioHandle)
-#define INCL_VIO
-#include <os2.h>
-ULONG     Row;
-USHORT    Column;
-HVIO      VioHandle;  /*  VIO presentation-space handle. */
-APIRET    rc;         /*  Return code. */
-rc = VioSetCurPos(Row, Column, VioHandle);
-</PRE>
 ==Parameters==
-; Row (ULONG) - input : New cursor row position, where 0 is the top row.
+;Row (ULONG) - input: New cursor row position, where 0 is the top row.
+;Column (USHORT) - input: New cursor column position, where 0 is the leftmost column.
-; Column (USHORT) - input : New cursor column position, where 0 is the leftmost column.
+;VioHandle (HVIO) - input: VIO 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]].
-; VioHandle (HVIO) - input : VIO 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
+;rc (APIRET) - returns:VioSetCurPos returns one of the following values:
+*0 NO_ERROR
-VioSetCurPos returns one of the following values:
+*355 ERROR_VIO_MODE
+*358 ERROR_VIO_ROW
-* 0     NO_ERROR
+*359 ERROR_VIO_COL
-* 355   ERROR_VIO_MODE
+*421 ERROR_VIO_INVALID_PARMS
-* 358   ERROR_VIO_ROW
+*436 ERROR_VIO_INVALID_HANDLE
-* 359   ERROR_VIO_COL
-* 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]]