VioShowPS: Difference between revisions

Latest revision as of 22:49, 7 January 2024

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

VioCreatePS

@@ Line 1: / Line 1: @@
-==Description==
 Updates the display of the VIO presentation space.
 ==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==
-;  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==
- rc (APIRET) - returns
+;rc (APIRET) - returns:Return code descriptions are:
+*0  NO_ERROR
-Return code descriptions are:
+*421 ERROR_VIO_INVALID_PARMS
+*436 ERROR_VIO_INVALID_HANDLE
-* 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.
+This call has the same function as [[VioShowBuf]], but the area to update is specified differently.
-==Example Code==
-<PRE>
-</PRE>
 ==Related Functions==
+*[[VioCreatePS]]
+[[Category:Vio]]
-[[Category:The OS/2 API Project]]