VioGetConfig: Difference between revisions

Latest revision as of 22:00, 1 January 2020

Returns the video display configuration.

Syntax

VioGetConfig(ConfigID, ConfigData, VioHandle)

Parameters

ConfigID (ULONG) - input

Configuration ID.

Identifies the display configuration for which information is being requested:

0 - Current configuration

1 - Primary configuration

2 - Secondary configuration

ConfigData (PVIOCONFIGINFO) - output: Pointer to the configuration data.
VioHandle (HVIO) - input: 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.

Remarks

The values returned might not be correct if the adapter cannot be properly identified or if the device is not capable of returning its settings.

@@ Line 1: / Line 1: @@
-==Description==
 Returns the video display configuration.
 ==Syntax==
-<PRE>
+ VioGetConfig(ConfigID, ConfigData, VioHandle)
-#define INCL_VIO
-#include <os2.h>
-ULONG             ConfigID;    /*  Configuration ID. */
-PVIOCONFIGINFO    ConfigData;  /*  Pointer to the configuration data. */
-HVIO              VioHandle;   /*  Presentation-space handle. */
-APIRET            rc;          /*  Return code. */
-rc = VioGetConfig(ConfigID, ConfigData, VioHandle);
-</PRE>
 ==Parameters==
-; ConfigID (ULONG) - input : Configuration ID.
+;ConfigID (ULONG) - input: Configuration ID.
-Identifies the display configuration for which information is being requested:
+:Identifies the display configuration for which information is being requested:
+::0 - Current configuration
-   Value         Definition
+::1 - Primary configuration
-           Current configuration
+::2 - Secondary configuration
-           Primary configuration
+;ConfigData (P[[VIOCONFIGINFO]]) - output: Pointer to the configuration data.
-           Secondary configuration
+;VioHandle (HVIO) - input : 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]].
-; ConfigData (PVIOCONFIGINFO) - output : Pointer to the configuration data.
-; VioHandle (HVIO) - input : 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==
 ==Remarks==
 The values returned might not be correct if the adapter cannot be properly identified or if the device is not capable of returning its settings.
-==Example Code==
-[[Category:The OS/2 API Project]]
+[[Category:Vio]]