Navigation:  thinBasic Modules > Console >

Console_SetOutputMode

Previous pageReturn to chapter overviewNext page

 

Description

 

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

 

Syntax

 

Console_SetOutputMode(nMode AS NUMBER) AS NUMBER

 

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

Number

No

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





 

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_GetOutputMode, Console_SetInputMode

 

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