* * 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 attributes of characters written to the console screen buffer or echoed.
Syntax
Console_SetTextAttribute(nAttribute)
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 |
nAttribute |
Number |
No |
The new text attribute. |
Remarks
This function affects text written after the function call.
The attribute can be one or more of the following values:
%Console_FOREGROUND_BLUE
%Console_FOREGROUND_GREEN
%Console_FOREGROUND_RED
%Console_FOREGROUND_INTENSITY
%Console_BACKGROUND_BLUE
%Console_BACKGROUND_GREEN
%Console_BACKGROUND_RED
%Console_BACKGROUND_INTENSITY
%Console_COMMON_LVB_LEADING_BYTE
%Console_COMMON_LVB_TRAILING_BYTE
%Console_COMMON_LVB_GRID_HORIZONTAL
%Console_COMMON_LVB_GRID_LVERTICAL
%Console_COMMON_LVB_GRID_RVERTICAL
%Console_COMMON_LVB_REVERSE_VIDEO
%Console_COMMON_LVB_UNDERSCORE
Restrictions
See also
Console Module, Console_Write, Console_WriteLine
Examples
Console_SetTextAttribute(%Console_FOREGROUND_BLUE) ' blue text
