VioEndPopUp: Difference between revisions

Latest revision as of 18:32, 1 January 2020

Redirects video output back to the normal video buffer. This function should be issued by the application when it no longer requires the temporary screen obtained through a previous VioPopUp call.

Syntax

VioEndPopUp (VioHandle)

Parameters

VioHandle (HVIO) - input: Reserved. Must be 0.

rc (APIRET) - returns

VioEndPopUp returns one of the following values:

0 NO_ERROR

405 ERROR_VIO_NO_POPUP

421 ERROR_VIO_INVALID_PARMS

436 ERROR_VIO_INVALID_HANDLE

Remarks

When the application issues a VioEndPopUp call, all video calls are directed to the application's normal video buffer. An error is returned if the call is issued with a non-zero handle.

@@ Line 1: / Line 1: @@
-==Description==
+Redirects video output back to the normal video buffer. This function should be issued by the application when it no longer requires the temporary screen obtained through a previous [[VioPopUp]] call.
-Redirects video output back to the normal video buffer. This function should be issued by the application when it no longer requires the temporary screen obtained through a previous VioPopUp call.
 ==Syntax==
-<PRE>
+ VioEndPopUp (VioHandle)
-#define INCL_VIO
-#include <os2.h>
-HVIO      VioHandle;  /*  Reserved.  Must be 0. */
-APIRET    rc;         /*  Return code. */
-rc = VioEndPopUp(VioHandle);
-</PRE>
 ==Parameters==
-;  VioHandle (HVIO) - input : Reserved. Must be 0.
+;VioHandle ([[HVIO]]) - input: Reserved. Must be 0.
-==Return Code==
- rc (APIRET) - returns
-VioEndPopUp returns one of the following values:
+;rc (APIRET) - returns:VioEndPopUp returns one of the following values:
+::0 NO_ERROR
+::405 ERROR_VIO_NO_POPUP
+::421 ERROR_VIO_INVALID_PARMS
+::436 ERROR_VIO_INVALID_HANDLE
-* 0    NO_ERROR
-* 405        ERROR_VIO_NO_POPUP
-* 421        ERROR_VIO_INVALID_PARMS
-* 436        ERROR_VIO_INVALID_HANDLE
 ==Remarks==
 When the application issues a VioEndPopUp call, all video calls are directed to the application's normal video buffer. An error is returned if the call is issued with a non-zero handle.
-==Example Code==
-<PRE>
-</PRE>
-==Related Functions==
-* [[OS2 API:CPI:
-[[Category:The OS/2 API Project]]
+[[Category:Vio]]