Navigation:  thinBasic Modules > Console >

Console_SetInputMode

Previous pageReturn to chapter overviewNext page

 

Description

 

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

 

Syntax

 

Console_SetInputMode(nMode)

 

Returns

 

Return a number

If the function fails, the return value is zero.

If the function succeeds, the return value is nonzero.

 

Parameters

 

Name

Type

Optional

Meaning

nMode

Numeric

No

The new input mode of a console's input buffer.





 

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_GetInputMode, Console_GetOutputMode, Console_SetOutputMode

 

Examples

 

dim nMode as number

 

nMode = Console_GetOutputMode()

if nMode and %Console_ENABLE_WRAP_AT_EOL_OUTPUT then

  Console_WriteLine("The wrap at end of line is enabled.")

else

  Console_SetInputMode(nMode OR %Console_ENABLE_WRAP_AT_EOL_OUTPUT)

  Console_WriteLine("The wrap at end of line is now enabled.")

end if