VioSetAnsi: Difference between revisions

Latest revision as of 19:01, 1 January 2020

Activates or deactivates ANSI support.

Syntax

VioSetAnsi (Indicator, VioHandle)

Parameters

Indicator (ULONG) - input: On/Off indicator.; Equals 1 to activate ANSI support, or 0 to deactivate ANSI.
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: VioSetAnsi returns one of the following values:

  0 NO_ERROR
355 ERROR_VIO_MODE
421 ERROR_VIO_INVALID_PARMS
430 ERROR_VIO_ILLEGAL_DURING_POPUP
436 ERROR_VIO_INVALID_HANDLE

Remarks

For ANSI support, "ON" is the default.

@@ Line 1: / Line 1: @@
-==Description==
 Activates or deactivates ANSI support.
 ==Syntax==
-<PRE>
+ VioSetAnsi (Indicator, VioHandle)
-#define INCL_VIO
-#include <os2.h>
-ULONG     Indicator;  /*  On/Off indicator. */
-HVIO      VioHandle;  /*  VIO presentation-space handle. */
-APIRET    rc;         /*  Return code. */
-rc = VioSetAnsi(Indicator, VioHandle);
-</PRE>
 ==Parameters==
-; Indicator (ULONG) - input : On/Off indicator.
+;Indicator (ULONG) - input: On/Off indicator.
-Equals 1 to activate ANSI support, or 0 to deactivate ANSI.
+:Equals 1 to activate ANSI support, or 0 to deactivate ANSI.
+;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==
- rc (APIRET) - returns
+;rc (APIRET) - returns:VioSetAnsi returns one of the following values:
+NO_ERROR
-VioSetAnsi returns one of the following values:
+ERROR_VIO_MODE
+ERROR_VIO_INVALID_PARMS
-* 0          NO_ERROR
+ERROR_VIO_ILLEGAL_DURING_POPUP
-* 355        ERROR_VIO_MODE
+ERROR_VIO_INVALID_HANDLE
-* 421        ERROR_VIO_INVALID_PARMS
-* 430        ERROR_VIO_ILLEGAL_DURING_POPUP
-* 436        ERROR_VIO_INVALID_HANDLE
 ==Remarks==
 For ANSI support, "ON" is the default.
-==Example Code==
+[[Category:Vio]]
-<PRE>
-</PRE>
-==Related Functions==
-* [[OS2 API:CPI:
-[[Category:The OS/2 API Project]]