VioShowBuf: Difference between revisions

Latest revision as of 16:16, 6 July 2019

Updates the physical display buffer with the logical video buffer (LVB).

Syntax

VioShowBuf(OffSet, Length, VioHandle)

Parameters

OffSet (ULONG) - input: Offset into the LVB.; Starting offset, within the LVB, where the update to the screen is to start.
Length (ULONG) - input: Length of the area to be updated to the screen.
VioHandle (HVIO) - input: VIO presentation-space handle.; This must be 0, unless the caller is a Presentation Manager application; in this case, it must be the value returned by VioCreatePS.

Return Code

rc (APIRET) - returns: Return code descriptions are:

0 NO_ERROR
355 ERROR_VIO_MODE
421 ERROR_VIO_INVALID_PARMS
430 ERROR_VIO_ILLEGAL_DURING_POPUP
436 ERROR_VIO_INVALID_HANDLE

Remarks

VioShowBuf is ignored unless it is issued by a process that is currently executing in the foreground or in a window.

@@ Line 1: / Line 1: @@
-==Description==
 Updates the physical display buffer with the logical video buffer (LVB).
 ==Syntax==
-<PRE>
+ VioShowBuf(OffSet, Length, VioHandle)
-#define INCL_VIO
-#include <os2.h>
-ULONG     OffSet;     /*  Offset into the LVB. */
-ULONG     Length;
-HVIO      VioHandle;  /*  VIO presentation-space handle. */
-APIRET    rc;         /*  Return code */
-rc = VioShowBuf(OffSet, Length, VioHandle);
-</PRE>
 ==Parameters==
-; OffSet (ULONG) - input :  Offset into the LVB.
+;OffSet (ULONG) - input :  Offset into the LVB.
-Starting offset, within the LVB, where the update to the screen is to start.
+:Starting offset, within the LVB, where the update to the screen is to start.
+;Length (ULONG) - input : Length of the area to be updated to the screen.
-; Length (ULONG) - input : Length of the area to be updated to the screen.
+;VioHandle (HVIO) - input : VIO presentation-space handle.
+:This must be 0, unless the caller is a Presentation Manager application; in this case, it must be the value returned by [[VioCreatePS]].
-; VioHandle (HVIO) - input :
-VIO presentation-space handle.
-This must be 0, unless the caller is a Presentation Manager application; in this case, it must be the value returned by VioCreatePS.
 ==Return Code==
- rc (APIRET) - returns
+;rc (APIRET) - returns:Return code descriptions are:
+* 0   NO_ERROR
-Return code descriptions are:
+* 355 ERROR_VIO_MODE
+* 421 ERROR_VIO_INVALID_PARMS
+* 430 ERROR_VIO_ILLEGAL_DURING_POPUP
+* 436 ERROR_VIO_INVALID_HANDLE
-* 0          NO_ERROR
-* 355        ERROR_VIO_MODE
-* 421        ERROR_VIO_INVALID_PARMS
-* 430        ERROR_VIO_ILLEGAL_DURING_POPUP
-* 436        ERROR_VIO_INVALID_HANDLE
 ==Remarks==
 VioShowBuf is ignored unless it is issued by a process that is currently executing in the foreground or in a window.
-==Example Code==
-<PRE>
-</PRE>
-==Related Functions==
-* [[OS2 API:CPI:
-[[Category:The OS/2 API Project]]
+[[Category:Vio]]