VioSetState

Description

Sets one or more of the following states:

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

Syntax

#define INCL_VIO
#include <os2.h>

PVIOD     RequestBlock;
HVIO      VioHandle;     /*  VIO presentation-space handle */
APIRET    rc;            /*  Return code. */

rc = VioSetState(RequestBlock, VioHandle);

Parameters

RequestBlock (PVIOD) - input

Address of the video state structures (consisting of six different structures, depending on the request type):

 Type           Definition  
0            Set palette registers 
1            Set overscan (border) color 
2            Set blink/background intensity switch 
3            Set color registers 
4            Reserved 
5            Set underline location 
6            Set target VioSetMode display configuration 

The six structures, depending on request type, are:

• VIOPALSTATE
• VIOOVERSCAN
• VIOINTENSITY
• VIOCOLORREG
• VIOSETULINELOC
• VIOSETTARGET

VioHandle (HVIO) - input

VIO presentation-space handle

Reserved. Must be 0.

Return Code

rc (APIRET) - returns

VioSetState 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

VioSetState allows setting of hardware-dependent features. Not all video hardware will honor these settings.

Related Functions

• [[OS2 API:CPI: