<< Click to Display Table of Contents >> Navigation:  ThinBASIC Modules > Console > Console_GetInputMode

 

Description

 

Retrieves the current input mode of a console's input buffer.

 

Syntax

 

n = Console_GetInputMode()

 

Returns

 

Return a number

If the function fails, the return value is zero.

If the function succeeds, the return value is nonzero and it's the current console input mode.

 

Parameters

 

 

Remarks

 

The mode can be one or more of the following values:

%Console_ENABLE_LINE_INPUT

%Console_ENABLE_ECHO_INPUT

%Console_ENABLE_PROCESSED_INPUT

%Console_ENABLE_WINDOW_INPUT

%Console_ENABLE_MOUSE_INPUT

%Console_ENABLE_INSERT_MODE

%Console_ENABLE_QUICK_EDIT_MODE

%Console_ENABLE_EXTENDED_FLAGS

%Console_ENABLE_AUTO_POSITION

 

Restrictions

 

See also

 

Console Module, Console_GetOutputMode, Console_SetInputMode, Console_SetOutputMode

 

Examples

 

If Console_GetInputMode() And %Console_ENABLE_ECHO_Input Then

Console_WriteLine("The console echo is enabled.")

End If