* * HELP & MANUAL PREMIUM PACK 4 DEMO VERSION * *
This documentation was styled with a demo skin from the Premium Pack 4 add-on for Help & Manual. The contents of the skin are encrypted and not configurable. You can only publish HM projects with this skin. You cannot edit it or change it.
This version is copyright and may only be used for local testing purposes. It may not be distributed.
Please purchase the full version of the Premium Pack to get the configurable skins and remove this notice. The package will also include the Toolbox configuration utility for Premium Pack skins.
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
