Jump to content

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

From EDM2
Ak120 (talk | contribs)
No edit summary
Line 1: Line 1:
{{Legacy
|RepFunc=[[VioGetAnsi]]
|Remarks=This page list the older version of the function for reference.
}}
This call returns the current ANSI status On/Off state.
This call returns the current ANSI status On/Off state.



Revision as of 23:17, 16 September 2017

Legacy Function Warning
It is recommended to use a newer replacement for this function.
Replacement: VioGetAnsi
Remarks: This page list the older version of the function for reference.

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