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 |
||
| Line 1: | Line 1: | ||
Returns the current ANSI status on and off state. | Returns the current ANSI status on and off state. | ||
| Line 12: | Line 11: | ||
rc = VioGetAnsi(Indicator, VioHandle); | rc = VioGetAnsi(Indicator, VioHandle); | ||
</PRE> | |||
==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: | ||
:*ANSI is active | |||
* | :*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. | |||
; VioHandle (HVIO) - input : Presentation-space handle. | |||
==Return Code== | ==Return Code== | ||
rc (APIRET) - returns | rc (APIRET) - returns | ||
VioGetAnsi returns one of the following values: | VioGetAnsi 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 | ||
==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]] | ||
Revision as of 02:38, 21 December 2016
Returns the current ANSI status on and off state.
Syntax
#define INCL_VIO #include <os2.h> PULONG Indicator; /* Address of the current ANSI status. */ HVIO VioHandle; /* Presentation-space handle. */ APIRET rc; /* Return code. */ rc = VioGetAnsi(Indicator, VioHandle);
Parameters
- Indicator (PULONG) - output
- Address of the current ANSI status.
- The ANSI status may be one of the following values:
- ANSI is active
- 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.