Differences

This shows you the differences between two versions of the page.

--- en:docs:fapi:viosavredrawwait [2021/09/05 05:23] – created prokushev
+++ en:docs:fapi:viosavredrawwait [2021/11/04 12:34] (current) – prokushev
@@ Line 1: / Line 1: @@
+{{page>en:templates:fapiint}}
+====== VioSavRedrawWait ======
 This call notifies a graphics mode application when it must save or redraw its screen image.
-==Syntax==
+===== Syntax =====
+<code c>
  VioSavRedrawWait (SavRedrawIndic, NotifyType, VioHandle)
+</code>
-==Parameters==
+===== Parameters =====
-;SavRedrawIndic (USHORT) - input : Indicates which events the application is waiting for:
-::0 - The session manager notifies the application for both save and redraw operations.
-::1 - The session manager notifies the application for redraw operations only.
-;NotifyType (PUSHORT) - output : Address that specifies the operation to be performed by the application upon return from VioSavRedrawWait:
-::0 - Save screen image
-::1 - Restore screen image.
-;VioHandle (HVIO) - input : Reserved word of 0s.
-==Return Code==
+  * SavRedrawIndic ([[USHORT]]) - input : Indicates which events the application is waiting for:
-;rc (USHORT) - return:Return code descriptions are:
+    * 0 - The session manager notifies the application for both save and redraw operations.
-*0 NO_ERROR
+    * 1 - The session manager notifies the application for redraw operations only.
-*421 ERROR_VIO_INVALID_PARMS
+  * NotifyType ([[PUSHORT]]) - output : Address that specifies the operation to be performed by the application upon return from VioSavRedrawWait:
-*422 ERROR_VIO_FUNCTION_OWNED
+    * 0 - Save screen image
-*423 ERROR_VIO_RETURN
+    * 1 - Restore screen image.
-*430 ERROR_VIO_ILLEGAL_DURING_POPUP
+  * VioHandle ([[HVIO]]) - input : Reserved word of 0s.
-*436 ERROR_VIO_INVALID_HANDLE
-*465 ERROR_VIO_DETACHED
+===== Return Code =====
-*494 ERROR_VIO_EXTENDED_SG
+rc (USHORT) - return:Return code descriptions are:
+  *0 NO_ERROR
+  *421 ERROR_VIO_INVALID_PARMS
+  *422 ERROR_VIO_FUNCTION_OWNED
+  *423 ERROR_VIO_RETURN
+  *430 ERROR_VIO_ILLEGAL_DURING_POPUP
+  *436 ERROR_VIO_INVALID_HANDLE
+  *465 ERROR_VIO_DETACHED
+  *494 ERROR_VIO_EXTENDED_SG
+===== Remarks =====
-==Remarks==
 OS/2 uses VioSavRedrawWait to notify a graphics mode application to save or restore its screen image at screen switch time. The application in the outgoing foreground session is notified to perform a save. The application in the incoming foreground session is notified to perform a restore. The application must perform the action requested and immediately re-issue VioSavRedrawWait. When an application performs a save, it saves its physical display buffer, video mode, and any other information the application needs to completely redraw its screen at restore time.
@@ Line 39: / Line 49: @@
 An application's VioSavRedrawWait thread may be notified to perform a restore before it is notified to perform a save. This happens if the application was running in the background the first time it issued VioSavRedrawWait. The return from this function call provides the notification. The thread that issues the call performs the save or redraw and then reissues VioSavRedrawWait to wait until its screen image must be saved or redrawn again.
-==Bindings==
+===== Bindings =====
-===C===
-<PRE>
+==== C ====
+<code c>
 #define INCL_VIO
@@ Line 51: / Line 63: @@
 USHORT  rc;             /* return code */
-</PRE>
+</code>
-===MASM===
+==== MASM ====
-<PRE>
+<code asm>
 EXTRN  VioSavRedrawWait:FAR
 INCL_VIO            EQU 1
@@ Line 64: / Line 77: @@
 Returns WORD
-</PRE>
+</code>
 [[http://www.edm2.com/index.php/VioSavRedrawWait_(OS/2_1.x)]]
+{{page>en:templates:fapi}}