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

 

Description

 

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

 

Syntax

 

n = Console_GetOutputMode()

 

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 output mode.

 

Parameters

 

 

Remarks

 

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

       %Console_ENABLE_PROCESSED_OUTPUT

       %Console_ENABLE_WRAP_AT_EOL_OUTPUT

 

Restrictions

 

See also

 

Console Module, Console_GetInputMode, Console_SetInputMode, Console_SetOutputMode

 

Examples

 

   if Console_GetOutputMode() and %Console_ENABLE_WRAP_AT_EOL_OUTPUT then

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

   end if