VioGetMode: Difference between revisions
mNo edit summary |
mNo edit summary |
||
| Line 5: | Line 5: | ||
==Parameters== | ==Parameters== | ||
;ModeData ( | ;ModeData (P[[VIOMODEINFO]]) - 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. | ;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]]. | :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:VioGetMode returns one of the following values: | |||
VioGetMode returns one of the following values: | *0 NO_ERROR | ||
* 0 | *421 ERROR_VIO_INVALID_PARMS | ||
* 421 | *436 ERROR_VIO_INVALID_HANDLE | ||
* 436 | *438 ERROR_VIO_INVALID_LENGTH | ||
* 438 | |||
==Remarks== | ==Remarks== | ||
* [[VioSetMode]] has some example. | * [[VioSetMode]] has some example. | ||
[[Category:Vio]] | [[Category:Vio]] | ||
Latest revision as of 18:52, 1 January 2020
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.