VioGetState: Difference between revisions

Revision as of 22:12, 1 January 2020

Gets the current settings of the:

Blink and background intensity switch
Color registers
Overscan (border) color
Palette registers
Target VioSetMode display configuration
Underline location

Syntax

VioGetState(RequestBlock, VioHandle)

Parameters

RequestBlock (PVIOD) - in/out: Request block.; The address of the video-state structures consisting of six different structures depending on the request type:

Type	Definition
0	Get palette registers
1	Get overscan (border) color
2	Get blink and background intensity switch
3	Get color registers
4	Reserved
5	Get the scan line for underlining
6	Get target VioSetMode display configuration

The six structures, depending on request type, are:

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

Return Code

rc (APIRET) - returns: VioGetState returns one of the following values:

0 NO_ERROR
355 ERROR_VIO_MODE
421 ERROR_VIO_INVALID_PARMS
436 ERROR_VIO_INVALID_HANDLE
438 ERROR_VIO_INVALID_LENGTH

Remarks

Note: VioGetState allows access to hardware-dependent features. Not all video hardware will honor these settings or return valid settings.

@@ Line 1: / Line 1: @@
-==Description==
 Gets the current settings of the:
 * Blink and background intensity switch
@@ Line 6: / Line 5: @@
 * Palette registers
 * Target VioSetMode display configuration
 * Underline location
 ==Syntax==
-<PRE>
+ VioGetState(RequestBlock, VioHandle)
-#define INCL_VIO
-#include <os2.h>
-PVIOD     RequestBlock;  /*  Request block. */
-HVIO      VioHandle;     /*  Reserved.  Must be 0. */
-APIRET    rc;            /*  Return code. */
-rc = VioGetState(RequestBlock, VioHandle);
-</PRE>
 ==Parameters==
 ;RequestBlock (PVIOD) - in/out : Request block.
-The address of the video-state structures consisting of six different structures depending on the request type:
+:The address of the video-state structures consisting of six different structures depending on the request type:
- Type  Definition
+:{|
-   Get palette registers
+!Type||Definition
-   Get overscan (border) color
+|-
-   Get blink and background intensity switch
+|0||Get palette registers
-   Get color registers
+|-
-   Reserved
+|1||Get overscan (border) color
-   Get the scan line for underlining
+|-
-   Get target VioSetMode display configuration
+|2||Get blink and background intensity switch
-The six structures, depending on request type, are:
+|-
- VIOPALSTATE
+|3||Get color registers
- VIOOVERSCAN
+|-
- VIOINTENSITY
+|4||Reserved
- VIOCOLORREG
+|-
- VIOSETULINELOC
+|5||Get the scan line for underlining
- VIOSETTARGET
+|-
-;VioHandle (HVIO) - input : Reserved. Must be 0.
+|6||Get target VioSetMode display configuration
+|}
+:The six structures, depending on request type, are:
+:*[[VIOPALSTATE]]
+:*[[VIOOVERSCAN]]
+:*[[VIOINTENSITY]]
+:*[[VIOCOLORREG]]
+:*[[VIOSETULINELOC]]
+:*[[VIOSETTARGET]]
+;VioHandle (HVIO) - input: Reserved. Must be 0.
 ==Return Code==
- rc (APIRET) - returns
+;rc (APIRET) - returns:VioGetState returns one of the following values:
-VioGetState returns one of the following values:
+*0 NO_ERROR
-* 0   NO_ERROR
+*355 ERROR_VIO_MODE
-* 355 ERROR_VIO_MODE
+*421 ERROR_VIO_INVALID_PARMS
-* 421 ERROR_VIO_INVALID_PARMS
+*436 ERROR_VIO_INVALID_HANDLE
-* 436 ERROR_VIO_INVALID_HANDLE
+*438 ERROR_VIO_INVALID_LENGTH
-* 438 ERROR_VIO_INVALID_LENGTH
 ==Remarks==