Jump to content

VioSetState: Difference between revisions

From EDM2
← Older editNewer edit →
Ak120 (talk | contribs)
35,890 edits
m Ak120 moved page OS2 API:CPI:VioSetState to VioSetState
Ak120 (talk | contribs)
35,890 edits
mNo edit summary
Line 1: Line 1:
==Description==
Sets one or more of the following states:
Sets one or more of the following states:
* Blink and background intensity switch
* Blink and background intensity switch
Line 9: Line 8:


==Syntax==
==Syntax==
<PRE>
  VioSetState(RequestBlock, VioHandle)
#define INCL_VIO
#include <os2.h>
 
PVIOD    RequestBlock;
HVIO      VioHandle;    /*  VIO presentation-space handle */
APIRET    rc;            /* Return code. */
 
rc = VioSetState(RequestBlock, VioHandle);
</PRE>


==Parameters==
==Parameters==
; RequestBlock (PVIOD) - input : Address of the video state structures (consisting of six different structures, depending on the request type):
;RequestBlock (PVIOD) - input : Address of the video state structures (consisting of six different structures, depending on the request type):
 
  Type Definition
  Type         Definition
  0   Set palette registers
  0           Set palette registers  
  1   Set overscan (border) color
  1           Set overscan (border) color  
  2   Set blink/background intensity switch
  2           Set blink/background intensity switch  
  3   Set color registers
  3           Set color registers  
  4   Reserved
  4           Reserved  
  5   Set underline location
  5           Set underline location  
  6   Set target VioSetMode display configuration
  6           Set target VioSetMode display configuration  
 
The six structures, depending on request type, are:
The six structures, depending on request type, are:
* VIOPALSTATE
* VIOPALSTATE
Line 38: Line 26:
* VIOCOLORREG
* VIOCOLORREG
* VIOSETULINELOC
* VIOSETULINELOC
* VIOSETTARGET  
* VIOSETTARGET
 
;VioHandle (HVIO) - input : VIO presentation-space handle
; VioHandle (HVIO) - input : VIO presentation-space handle
:Reserved. Must be 0.
Reserved. Must be 0.


==Return Code==
==Return Code==
Line 55: Line 42:
VioSetState allows setting of hardware-dependent features. Not all video hardware will honor these settings.  
VioSetState allows setting of hardware-dependent features. Not all video hardware will honor these settings.  


==Example Code==
[[Category:Vio]]
 
==Related Functions==
 
[[Category:The OS/2 API Project]]

Revision as of 20:18, 26 February 2017

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

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.

Retrieved from "https://www.edm2.com/index.php?title=VioSetState&oldid=44335"