Jump to content

VioSetOrigin: Difference between revisions

From EDM2
Ak120 (talk | contribs)
Ak120 (talk | contribs)
mNo edit summary
Line 13: Line 13:


rc = VioSetOrigin(Row, Column, hvps);
rc = VioSetOrigin(Row, Column, hvps);
</PRE>


</PRE>
==Parameters==
==Parameters==
; Row (ULONG) - input : The top-most row shown in the window  
;Row (ULONG) - input : The top-most row shown in the window
 
;Column (ULONG) - input : The left-most column shown in the window.
; Column (ULONG) - input : 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==
==Return Code==
  rc (APIRET) - returns
  rc (APIRET) - returns
VioSetOrigin returns one of the following values:
VioSetOrigin returns one of the following values:
* 0          NO_ERROR  
* 0          NO_ERROR  
* 358        ERROR_VIO_ROW  
* 358        ERROR_VIO_ROW  
Line 39: Line 35:
In OS/2 2.x, hvps cannot be 0.  
In OS/2 2.x, hvps cannot be 0.  


==Example Code==
[[Category:Vio]]
<PRE>
 
</PRE>
==Related Functions==
*
 
[[Category:The OS/2 API Project]]

Revision as of 01:29, 14 January 2017

Description

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

Syntax

#define INCL_VIO
#include <os2.h>

ULONG     Row;     /*  The top-most row shown in the window */
ULONG     Column;  /*  The left-most column shown in the window. */
HVIO      hvps;    /*  VIO presentation-space handle. */
APIRET    rc;      /*  Return code. */

rc = 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

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.