VioGetAnsi: Difference between revisions
mNo edit summary |
mNo edit summary |
||
| Line 5: | Line 5: | ||
==Parameters== | ==Parameters== | ||
;Indicator (PULONG) - output : Address of the current ANSI status. | ;Indicator (PULONG) - output: Address of the current ANSI status. | ||
:The ANSI status may be one of the following values: | :The ANSI status may be one of the following values: | ||
: | ::1 - ANSI is active | ||
: | ::0 - ANSI is not active | ||
;VioHandle (HVIO) - input : Presentation-space handle. | ;VioHandle (HVIO) - input: 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:VioGetAnsi returns one of the following values: | ;rc (APIRET) - returns:VioGetAnsi returns one of the following values: | ||
* 0 NO_ERROR | *0 NO_ERROR | ||
* 421 | *421 ERROR_VIO_INVALID_PARMS | ||
* 436 | *436 ERROR_VIO_INVALID_HANDLE | ||
==Remarks== | ==Remarks== | ||
Latest revision as of 18:58, 1 January 2020
Returns the current ANSI status on and off state.
Syntax
VioGetAnsi(Indicator, VioHandle)
Parameters
- Indicator (PULONG) - output
- Address of the current ANSI status.
- The ANSI status may be one of the following values:
- 1 - ANSI is active
- 0 - ANSI is not active
- VioHandle (HVIO) - input
- 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
- VioGetAnsi returns one of the following values:
- 0 NO_ERROR
- 421 ERROR_VIO_INVALID_PARMS
- 436 ERROR_VIO_INVALID_HANDLE
Remarks
When the application issues a VioEndPopUp call, all video calls are directed to the application's normal video buffer. An error is returned if the call is issued with a non-zero handle.