Difference between revisions of "VioGetMode"
From EDM2
m (Ak120 moved page OS2 API:CPI:VioGetMode to VioGetMode) |
m |
||
| Line 1: | Line 1: | ||
| − | |||
Returns the mode of the display. | Returns the mode of the display. | ||
==Syntax== | ==Syntax== | ||
| − | + | VioGetMode (ModeData, VioHandle) | |
| − | + | ||
| − | + | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
==Parameters== | ==Parameters== | ||
| − | ; ModeData (PVIOMODEINFO) - in/out : Mode characteristics. | + | ;ModeData (PVIOMODEINFO) - in/out : Mode characteristics. |
| − | The address of a structure where mode characteristics are returned. | + | :The address of a structure where mode characteristics are returned. |
| + | ; VioHandle (HVIO) - input: VIO presentation-space handle. | ||
| + | :This must be 0, unless the caller is a Presentation Manager application; in this case, it must be the value returned by [[VioCreatePS]]. | ||
| − | |||
| − | |||
==Return Code== | ==Return Code== | ||
rc (APIRET) - returns | rc (APIRET) - returns | ||
| − | |||
VioGetMode returns one of the following values: | VioGetMode returns one of the following values: | ||
| − | + | * 0 NO_ERROR | |
| − | * 0 NO_ERROR | + | |
* 421 ERROR_VIO_INVALID_PARMS | * 421 ERROR_VIO_INVALID_PARMS | ||
* 436 ERROR_VIO_INVALID_HANDLE | * 436 ERROR_VIO_INVALID_HANDLE | ||
| Line 31: | Line 19: | ||
==Remarks== | ==Remarks== | ||
| − | * [[ | + | * [[VioSetMode]] has some example. |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
==Related Functions== | ==Related Functions== | ||
| − | * [[ | + | * [[VioCreatePS]] |
| − | + | * [[VioSetMode]] | |
| − | [[Category: | + | [[Category:Vio]] |
Revision as of 02:45, 13 February 2017
Returns the mode of the display.
Syntax
VioGetMode (ModeData, VioHandle)
Parameters
- ModeData (PVIOMODEINFO) - in/out
- Mode characteristics.
- The address of a structure where mode characteristics are returned.
- VioHandle (HVIO) - input
- VIO presentation-space handle.
- This must be 0, unless the caller is a Presentation Manager application; in this case, it must be the value returned by VioCreatePS.
Return Code
rc (APIRET) - returns
VioGetMode returns one of the following values:
- 0 NO_ERROR
- 421 ERROR_VIO_INVALID_PARMS
- 436 ERROR_VIO_INVALID_HANDLE
- 438 ERROR_VIO_INVALID_LENGTH
Remarks
- VioSetMode has some example.
