VioGetAnsi: Difference between revisions
Created page with "==Description== Returns the current ANSI status on and off state. ==Syntax== <PRE> #define INCL_VIO #include <os2.h> PULONG Indicator; /* Address of the current ANSI st..." |
mNo edit summary |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
Returns the current ANSI status on and off state. | Returns the current ANSI status on and off state. | ||
==Syntax== | ==Syntax== | ||
VioGetAnsi(Indicator, VioHandle) | |||
==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. | |||
: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: | |||
*0 NO_ERROR | |||
VioGetAnsi returns one of the following values: | *421 ERROR_VIO_INVALID_PARMS | ||
*436 ERROR_VIO_INVALID_HANDLE | |||
* 0 NO_ERROR | |||
* 421 | |||
* 436 | |||
==Remarks== | ==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. | 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. | ||
[[Category: | [[Category:Vio]] | ||
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.