VioGetMode: Difference between revisions

Latest revision as of 18:52, 1 January 2020

Returns the mode of the display.

Syntax

VioGetMode (ModeData, VioHandle)

Parameters

ModeData (PVIOMODEINFO) - in/out: Mode characteristics.; The address of a structure where mode characteristics are returned.
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: VioGetMode returns one of the following values:

0 NO_ERROR
421 ERROR_VIO_INVALID_PARMS
436 ERROR_VIO_INVALID_HANDLE
438 ERROR_VIO_INVALID_LENGTH

Remarks

VioSetMode has some example.

@@ Line 1: / Line 1: @@
-==Description==
 Returns the mode of the display.
 ==Syntax==
-<PRE>
+ VioGetMode (ModeData, VioHandle)
-#define INCL_VIO
-#include <os2.h>
-PVIOMODEINFO    ModeData;   /*  Mode characteristics. */
-HVIO            VioHandle;  /*  VIO presentation-space handle. */
-APIRET          rc;         /*  Return code. */
-rc = VioGetMode(ModeData, VioHandle);
-</PRE>
 ==Parameters==
-; ModeData (PVIOMODEINFO) - in/out : Mode characteristics.
+;ModeData (P[[VIOMODEINFO]]) - in/out: Mode characteristics.
-The address of a structure where mode characteristics are returned.
+:The address of a structure where mode characteristics are returned.
+;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:VioGetMode returns one of the following values:
+*0 NO_ERROR
-VioGetMode returns one of the following values:
+*421 ERROR_VIO_INVALID_PARMS
+*436 ERROR_VIO_INVALID_HANDLE
-* 0     NO_ERROR
+*438 ERROR_VIO_INVALID_LENGTH
-* 421   ERROR_VIO_INVALID_PARMS
-* 436   ERROR_VIO_INVALID_HANDLE
-* 438   ERROR_VIO_INVALID_LENGTH
 ==Remarks==
-* [[OS2 API:CPI:VioSetMode|VioSetMode]] has some example.
+* [[VioSetMode]] has some example.
-==Example Code==
-<PRE>
-</PRE>
-==Related Functions==
-* [[OS2 API:CPI:
-[[Category:The OS/2 API Project]]
+[[Category:Vio]]