VioGetAnsi: Difference between revisions

Revision as of 21:48, 14 October 2018

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:

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.

@@ Line 2: / Line 2: @@
 ==Syntax==
-<PRE>
+  VioGetAnsi(Indicator, VioHandle)
-#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);
-</PRE>
 ==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:
 :*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.
+: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
+;rc (APIRET) - returns:VioGetAnsi returns one of the following values:
-VioGetAnsi returns one of the following values:
 * 0 NO_ERROR
 * 421  ERROR_VIO_INVALID_PARMS
@@ Line 29: / Line 19: @@
 ==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:Vio]]