VioSetOrigin: Difference between revisions

Latest revision as of 18:47, 26 September 2017

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

Syntax

VioSetOrigin (Row, Column, hvps)

Parameters

Row (ULONG) - input: The top-most row shown in the window.
Column (ULONG) - input: 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.

Return Code

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

0 NO_ERROR
358 ERROR_VIO_ROW
359 ERROR_VIO_COL
421 ERROR_VIO_INVALID_PARMS
436 ERROR_VIO_INVALID_HANDLE

Remarks

VioSetOrigin is used when the presentation space is larger than the window size to control which part of the presentation space is displayed. It does not, itself, cause any output to be displayed.

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

@@ Line 1: / Line 1: @@
-==Description==
 Sets the position at which the presentation space maps to the window.
 ==Syntax==
-<PRE>
+ VioSetOrigin (Row, Column, hvps)
-#define INCL_VIO
-#include <os2.h>
-ULONG     Row;     /*  The top-most row shown in the window */
+===Parameters===
-ULONG     Column;  /*  The left-most column shown in the window. */
+;Row ([[ULONG]]) - input: The top-most row shown in the window.
-HVIO      hvps;    /*  VIO presentation-space handle. */
+;Column (ULONG) - input: The left-most column shown in the window.
-APIRET    rc;      /*  Return code. */
+;hvps ([[HVIO]]) - input: VIO presentation-space handle.
+:This is either 0 to indicate the default VIO session or a value returned by [[VioCreatePS]].
-rc = VioSetOrigin(Row, Column, hvps);
+===Return Code===
-</PRE>
+;rc (APIRET) - returns:one of the following values:
+*  0 NO_ERROR
-==Parameters==
+*358 ERROR_VIO_ROW
-;Row (ULONG) - input : The top-most row shown in the window
+*359 ERROR_VIO_COL
-;Column (ULONG) - input : The left-most column shown in the window.
+*421 ERROR_VIO_INVALID_PARMS
-;hvps (HVIO) - input : VIO presentation-space handle.
+*436 ERROR_VIO_INVALID_HANDLE
-This is either 0 to indicate the default VIO session or a value returned by VioCreatePS.
-==Return Code==
- rc (APIRET) - returns
-VioSetOrigin returns one of the following values:
-* 0          NO_ERROR
-* 358        ERROR_VIO_ROW
-* 359        ERROR_VIO_COL
-* 421        ERROR_VIO_INVALID_PARMS
-* 436        ERROR_VIO_INVALID_HANDLE
 ==Remarks==
 VioSetOrigin is used when the presentation space is larger than the window size to control which part of the presentation space is displayed. It does not, itself, cause any output to be displayed.
 In OS/2 2.x, hvps cannot be 0.
 [[Category:Vio]]