Jump to content

VioShowPS: Difference between revisions

From EDM2
Ak120 (talk | contribs)
m Ak120 moved page OS2 API:CPI:VioShowPS to VioShowPS
Ak120 (talk | contribs)
No edit summary
Line 1: Line 1:
==Description==
Updates the display of the VIO presentation space.
Updates the display of the VIO presentation space.


==Syntax==
==Syntax==
<PRE>
VioShowPS (Depth, Width, Cell, hvps)
#define INCL_VIO
#include <os2.h>


ULONG    Depth;  /*  Depth. */
ULONG    Width;  /*  Width. */
ULONG    Cell;  /*  Offset to first updated cell. */
HVIO      hvps;  /*  VIO presentation handle. */
APIRET    rc;    /*  Return code */
rc = VioShowPS(Depth, Width, Cell, hvps);
</PRE>
==Parameters==
==Parameters==
; Depth (ULONG) - input : Depth.
;Depth (ULONG) - input : Depth:The depth of the updated rectangle.
The depth of the updated rectangle.  
;Width (ULONG) - input : Width:The width of the updated rectangle.
 
;Cell (ULONG) - input : Offset to first updated cell:The offset to the first updated cell. The offset of the top-left corner is zero.
; Width (ULONG) - input : Width.
;hvps (HVIO) - input : VIO presentation handle:VIO presentation space handle. This is either zero to indicate the default VIO session or a value returned by VioCreatePS.  
The width of the updated rectangle.  
 
; Cell (ULONG) - input : Offset to first updated cell.
The offset to the first updated cell. The offset of the top-left corner is zero.  
 
; hvps (HVIO) - input : VIO presentation handle.
VIO presentation space handle. This is either zero to indicate the default VIO session or a value returned by VioCreatePS.  


==Return Code==
==Return Code==
  rc (APIRET) - returns
  rc (APIRET) - returns
Return code descriptions are:
Return code descriptions are:
 
* 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==
==Remarks==
This call is used to specify that part or all of the presentation space the logical buffer needs to be redrawn.
This call is used to specify that part or all of the presentation space the logical buffer needs to be redrawn.


This call has the same function as VioShowBuf, but the area to update is specified differently.  
This call has the same function as VioShowBuf, but the area to update is specified differently.


==Example Code==
<PRE>
</PRE>
==Related Functions==
==Related Functions==
*[[VioCreatePS]]


 
[[Category:Vio]]
 
[[Category:The OS/2 API Project]]

Revision as of 05:18, 13 February 2017

Updates the display of the VIO presentation space.

Syntax

VioShowPS (Depth, Width, Cell, hvps)

Parameters

Depth (ULONG) - input
Depth:The depth of the updated rectangle.
Width (ULONG) - input
Width:The width of the updated rectangle.
Cell (ULONG) - input
Offset to first updated cell:The offset to the first updated cell. The offset of the top-left corner is zero.
hvps (HVIO) - input
VIO presentation handle:VIO presentation space handle. This is either zero to indicate the default VIO session or a value returned by VioCreatePS.

Return Code

rc (APIRET) - returns

Return code descriptions are:

  • 0 NO_ERROR
  • 421 ERROR_VIO_INVALID_PARMS
  • 436 ERROR_VIO_INVALID_HANDLE

Remarks

This call is used to specify that part or all of the presentation space the logical buffer needs to be redrawn.

This call has the same function as VioShowBuf, but the area to update is specified differently.

Related Functions