VioGetState

From EDM2
Jump to: navigation, search

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 (PVOID) - in/out 
Request block.
The address of the video-state structures consisting of six different structures depending on the request type:
Type Definition Structure
0 Get palette registers VIOPALSTATE
1 Get overscan (border) colour VIOOVERSCAN
2 Get blink and background intensity switch VIOINTENSITY
3 Get color registers VIOCOLORREG
4 Reserved
5 Get the scan line for underlining VIOSETULINELOC
6 Get target VioSetMode display configuration VIOSETTARGET
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.