VioShowBuf (FAPI): Difference between revisions

Latest revision as of 17:16, 28 February 2020

This call updates the physical display buffer with the logical video buffer (LVB).

Syntax

VioShowBuf (Offset, Length, VioHandle)

Parameters

Offset (USHORT) - input: Starting offset within the logical video buffer at which the update to the screen is to start.
Length (USHORT) - input: Length of the area to be updated to the screen.
VioHandle (HVIO) - input: This must be zero unless the caller is a Presentation Manager application, in which case it must be the value returned by VioGetPs.

Return Code

rc (USHORT) - return: Return code descriptions are:

0 NO_ERROR
355 ERROR_VIO_MODE
430 ERROR_VIO_ILLEGAL_DURING_POPUP
436 ERROR_VIO_INVALID_HANDLE
465 ERROR_VIO_DETACHED

Remarks

VioShowBuf is ignored unless it is issued by a process that has previously called VioGetBuf and that is currently executing in the foreground.

PM Considerations

This function updates the display with the Advanced VIO presentation space.

Bindings

C

#define INCL_VIO

USHORT  rc = VioShowBuf(Offset, Length, VioHandle);

USHORT  Offset;        /* Offset into LVB */
USHORT  Length;        /* Length */
HVIO    VioHandle;     /* Video handle */

USHORT  rc;            /* return code */

MASM

EXTRN  VioShowBuf:FAR
INCL_VIO            EQU 1

PUSH   WORD    Offset        ;Offset into LVB
PUSH   WORD    Length        ;Length
PUSH   WORD    VioHandle     ;Video handle
CALL   VioShowBuf

Returns WORD

Related Functions

VioGetBuf

@@ Line 1: / Line 1: @@
-==Description==
 This call updates the physical display buffer with the logical video buffer (LVB).
 ==Syntax==
-<PRE>
+  VioShowBuf (Offset, Length, VioHandle)
-  VioShowBuf
-    (Offset, Length, VioHandle)
-</PRE>
 ==Parameters==
-;  Offset (USHORT) - input : Starting offset within the logical video buffer at which the update to the screen is to start.
+;Offset (USHORT) - input : Starting offset within the logical video buffer at which the update to the screen is to start.
+;Length (USHORT) - input : Length of the area to be updated to the screen.
-; Length (USHORT) - input : Length of the area to be updated to the screen.
+;VioHandle (HVIO) - input : This must be zero unless the caller is a Presentation Manager application, in which case it must be the value returned by VioGetPs.
-; VioHandle (HVIO) - input : This must be zero unless the caller is a Presentation Manager application, in which case it must be the value returned by VioGetPs.
 ==Return Code==
- rc (USHORT) - return
+;rc (USHORT) - return:Return code descriptions are:
+*0 NO_ERROR
-Return code descriptions are:
+*355 ERROR_VIO_MODE
+*430 ERROR_VIO_ILLEGAL_DURING_POPUP
-* 0          NO_ERROR
+*436 ERROR_VIO_INVALID_HANDLE
-* 355        ERROR_VIO_MODE
+*465 ERROR_VIO_DETACHED
-* 430        ERROR_VIO_ILLEGAL_DURING_POPUP
-* 436        ERROR_VIO_INVALID_HANDLE
-* 465        ERROR_VIO_DETACHED
 ==Remarks==
 VioShowBuf is ignored unless it is issued by a process that has previously called VioGetBuf and that is currently executing in the foreground.
 ===PM Considerations===
+This function updates the display with the Advanced VIO presentation space.
-This function updates the display with the Advanced VIO presentation space.
+==Bindings==
+===C===
-==Example Code==
-=== C Binding===
 <PRE>
 #define INCL_VIO
@@ Line 42: / Line 30: @@
 USHORT  rc = VioShowBuf(Offset, Length, VioHandle);
-USHORT           Offset;        /* Offset into LVB */
+USHORT  Offset;        /* Offset into LVB */
-USHORT           Length;        /* Length */
+USHORT  Length;        /* Length */
-HVIO             VioHandle;     /* Video handle */
+HVIO    VioHandle;     /* Video handle */
-USHORT           rc;            /* return code */
+USHORT  rc;            /* return code */
 </PRE>
-===MASM Binding===
+===MASM===
 <PRE>
 EXTRN  VioShowBuf:FAR
@@ Line 63: / Line 51: @@
 ==Related Functions==
-*
+* VioGetBuf
-[[Category:The OS/2 API Project]]
+[[Category:Vio]]