VioGetAnsi (OS/2 1.x): Difference between revisions

Revision as of 20:25, 26 February 2017

This call returns the current ANSI status On/Off state.

Syntax

VioGetAnsi (Indicator, VioHandle)

Parameters

Indicator (PUSHORT) - output: Address of the current ANSI status. A value of 1 indicates ANSI is active, and a value of 0 indicates ANSI is not active.
VioHandle (HVIO) - input: This must be zero unless the caller is a Presentation Manager application, in which case it must be the value returned by VioGetPs.

Return Code

rc (USHORT) - return

Return code descriptions are:

0 NO_ERROR
436 ERROR_VIO_INVALID_HANDLE
465 ERROR_VIO_DETACHED

Example Code

C Binding

#define INCL_VIO

USHORT  rc = VioGetAnsi(Indicator, VioHandle);

PUSHORT Indicator;     /* On/Off indicator (returned) */
HVIO    VioHandle;     /* Vio handle */

USHORT  rc;            /* return code */

MASM Binding

EXTRN  VioGetAnsi:FAR
INCL_VIO            EQU 1

PUSH@  WORD    Indicator     ;On/Off indicator (returned)
PUSH   WORD    VioHandle     ;Vio handle
CALL   VioGetAnsi

Returns WORD

@@ Line 1: / Line 1: @@
-==Description==
 This call returns the current ANSI status On/Off state.
 ==Syntax==
-<PRE>
+  VioGetAnsi (Indicator, VioHandle)
-  VioGetAnsi
-    (Indicator, VioHandle)
-</PRE>
 ==Parameters==
-;  Indicator (PUSHORT) - output : Address of the current ANSI status. A value of 1 indicates ANSI is active, and a value of 0 indicates ANSI is not active.
+;Indicator (PUSHORT) - output : Address of the current ANSI status. A value of 1 indicates ANSI is active, and a value of 0 indicates ANSI is not active.
+;VioHandle (HVIO) - input : This must be zero unless the caller is a Presentation Manager application, in which case it must be the value returned by VioGetPs.
-; VioHandle (HVIO) - input : This must be zero unless the caller is a Presentation Manager application, in which case it must be the value returned by VioGetPs.
 ==Return Code==
   rc (USHORT) - return
 Return code descriptions are:
 * 0          NO_ERROR
 * 436        ERROR_VIO_INVALID_HANDLE
 * 465        ERROR_VIO_DETACHED
-==Remarks==
 ==Example Code==
@@ Line 32: / Line 22: @@
 USHORT  rc = VioGetAnsi(Indicator, VioHandle);
-PUSHORT          Indicator;     /* On/Off indicator (returned) */
+PUSHORT Indicator;     /* On/Off indicator (returned) */
-HVIO             VioHandle;     /* Vio handle */
+HVIO    VioHandle;     /* Vio handle */
-USHORT           rc;            /* return code */
+USHORT  rc;            /* return code */
 </PRE>
@@ Line 49: / Line 39: @@
 Returns WORD
 </PRE>
-==Related Functions==
-*
-[[Category:The OS/2 API Project]]
+[[Category:Vio]]