Important Notice

The pages on this site contain documentation for very old MS-DOS software, purely for historical purposes. If you're looking for up-to-date documentation, particularly for programming, you should not rely on the information found here, as it will be woefully out of date.

◄Overview►                                            ◄Up► ◄Next► ◄Previous►
────────────────────────────────────────────────────────────────────────────
 
#define INCL_VIO
 
USHORT VioGetState(pvoidState, hvio)
PVOID pvoidState;    /* pointer to structure for state information */
HVIO hvio;           /* video handle                               */
 
The VioGetState function retrieves the current settings of the
screen-palette registers, the overscan (border) color, the blink/background
intensity switch, the screen color, the underline position, or the target
display.
 
The VioSetState function is a family API function.
 
Parameter   Description
────────────────────────────────────────────────────────────────────────────
 
pvoidState  Points to the structure that receives the state information. The
            structure type, which depends on the request type specified in
            the type field of each structure, is one of the following:
            VIOPALSTATE, VIOOVERSCAN, VIOINTENSITY, VIOCOLORREG,
            VIOSETULINELOC, or VIOSETTARGET.
 
hvio        Identifies an advanced video-input-and-output (AVIO)
            presentation space. For AVIO programs, this handle must have
            been created by using the VioCreatePS function. For other
            programs, hvio must be NULL.
 
Return Value
 
The return value is zero if the function is successful. Otherwise, it is an
error value, which may be one of the following:
 
     ERROR_VIO_INVALID_HANDLE
     ERROR_VIO_INVALID_LENGTH
 
Example
 
This example calls the VioGetState function to retrieve the settings for
each of the 16 palette registers.
 
BYTE abState[38];
PVIOPALSTATE pviopal;
pviopal = (PVIOPALSTATE) abState;
pviopal->cb = sizeof(abState); /* structure size                   */
pviopal->type = 0;             /* retrieves palette registers      */
pviopal->iFirst = 0;           /* first palette register to return */
VioGetState(pviopal, 0);
 
See Also
 
VioCreatePS, VioGetMode, VioSetState, VIOCOLORREG, VIOINTENSITY,
VIOOVERSCAN, VIOPALSTATE, VIOSETTARGET, VIOSETULINELOC
 
                                      ♦