Jump to content

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

From EDM2
Created page with "==Description== This call returns the current ANSI status On/Off state. ==Syntax== <PRE> VioGetAnsi (Indicator, VioHandle) </PRE> ==Parameters== ; Indicator (PUSHORT) ..."
 
Ak120 (talk | contribs)
35,819 edits
mNo edit summary
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
==Description==
This call returns the current ANSI status On/Off state.
This call returns the current ANSI status On/Off state.


==Syntax==
==Syntax==
<PRE>
  VioGetAnsi (Indicator, VioHandle)
  VioGetAnsi


    (Indicator, VioHandle)
</PRE>
==Parameters==
==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==
==Return Code==
rc (USHORT) - return
;rc (USHORT) - return:Return code descriptions are:
 
* 0 NO_ERROR
Return code descriptions are:
*436 ERROR_VIO_INVALID_HANDLE
 
*465 ERROR_VIO_DETACHED
* 0         NO_ERROR  
* 436       ERROR_VIO_INVALID_HANDLE  
* 465       ERROR_VIO_DETACHED
 
==Remarks==
 


==Example Code==
==Bindings==
===C Binding===
===C===
<PRE>
<PRE>
#define INCL_VIO
#define INCL_VIO
Line 32: Line 21:
USHORT  rc = VioGetAnsi(Indicator, VioHandle);
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>
</PRE>


===MASM Binding===
===MASM===
<PRE>
<PRE>
EXTRN  VioGetAnsi:FAR
EXTRN  VioGetAnsi:FAR
Line 49: Line 38:
Returns WORD
Returns WORD
</PRE>
</PRE>
==Related Functions==
*


[[Category:The OS/2 API Project]]
[[Category:Vio]]

Latest revision as of 18:34, 14 September 2019

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

Bindings

C

#define INCL_VIO

USHORT  rc = VioGetAnsi(Indicator, VioHandle);

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

USHORT  rc;            /* return code */

MASM

EXTRN  VioGetAnsi:FAR
INCL_VIO            EQU 1

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

Returns WORD
Retrieved from "https://www.edm2.com/index.php?title=VioGetAnsi_(OS/2_1.x)&oldid=63925"