Jump to content

VioGetOrigin: Difference between revisions

From EDM2
Created page with "==Description== Gets the position at which the presentation space maps to the window. ==Syntax== <PRE> #define INCL_VIO #include <os2.h> PULONG Row; PULONG Column; HVI..."
 
Ak120 (talk | contribs)
mNo edit summary
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
==Description==
Gets the position at which the presentation space maps to the window.
Gets the position at which the presentation space maps to the window.


==Syntax==
==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==
==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. This is either 0 to indicate the default VIO session, or a value returned by [[VioCreatePS]].
 
; 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==
==Return Code==
rc (APIRET) - returns
;rc (APIRET) - returns:VioGetOrigin returns one of the following values:
 
*0 NO_ERROR
VioGetOrigin returns one of the following values:
*421 ERROR_VIO_INVALID_PARMS
 
*436 ERROR_VIO_INVALID_HANDLE
* 0         NO_ERROR  
* 421       ERROR_VIO_INVALID_PARMS  
* 436       ERROR_VIO_INVALID_HANDLE


==Remarks==
==Remarks==
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]]

Latest revision as of 18:12, 29 August 2021

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

Syntax

VioGetOrigin(Row, Column, hvps)

Parameters

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.

Return Code

rc (APIRET) - returns
VioGetOrigin returns one of the following values:
  • 0 NO_ERROR
  • 421 ERROR_VIO_INVALID_PARMS
  • 436 ERROR_VIO_INVALID_HANDLE

Remarks

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