VioGetOrigin: Difference between revisions

Latest revision as of 18:12, 29 August 2021

Gets the position at which the presentation space maps to the window.

VioGetOrigin(Row, Column, hvps)

Row (PULONG) - input: Location to return the top-most row shown in the window.
Column (PULONG) - input: Location to return the left-most column shown in the window.
hvps (HVIO) - input: VIO presentation-space handle. This is either 0 to indicate the default VIO session, or a value returned by VioCreatePS.

In OS/2 2.x, hvps cannot be 0.

@@ Line 2: / Line 2: @@
 ==Syntax==
-<PRE>
+  VioGetOrigin(Row, Column, hvps)
-#define INCL_VIO
-#include <os2.h>
-PULONG    Row;
-PULONG    Column;
-HVIO      hvps;    /*  VIO presentation-space handle. */
-APIRET    rc;      /*  Return code. */
-rc = VioGetOrigin(Row, Column, hvps);
-</PRE>
 ==Parameters==
-;Row (PULONG) - input : Location to return the top-most row shown in the window.
+;Row (PULONG) - input: Location to return the top-most row shown in the window.
-;Column (PULONG) - input : Location to return the left-most column shown in the window.
+;Column (PULONG) - input: Location to return the left-most column shown in the window.
-;hvps (HVIO) - input : VIO presentation-space handle.
+;hvps (HVIO) - input: VIO presentation-space handle. This is either 0 to indicate the default VIO session, or a value returned by [[VioCreatePS]].
-:This is either 0 to indicate the default VIO session, or a value returned by VioCreatePS.
 ==Return Code==
- rc (APIRET) - returns
+;rc (APIRET) - returns:VioGetOrigin returns one of the following values:
-VioGetOrigin returns one of the following values:
+*0 NO_ERROR
-* 0 NO_ERROR
+*421 ERROR_VIO_INVALID_PARMS
-* 421 ERROR_VIO_INVALID_PARMS
+*436 ERROR_VIO_INVALID_HANDLE
-* 436 ERROR_VIO_INVALID_HANDLE
 ==Remarks==