Navigation:  thinBasic Modules > Console >

Console_SetTextAttribute

Previous pageReturn to chapter overviewNext page

 

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