<< Click to Display Table of Contents >> Navigation:  ThinBASIC Modules > Console > Console Cursor Handling > Console_GetCursorSize

 

Description

 

Retrieves information about the size of the cursor for the console screen.

 

Syntax

 

n = Console_GetCursorSize()

 

Returns

 

Return a number

If the function fails, the return value is zero.

If the function succeeds, the return value is nonzero. In this case the value is between 1 and 100 and it's the percentage of the character cell that is filled by the cursor.

 

Parameters

 

 

Remarks

 

The cursor appearance varies, ranging from completely filling the cell to showing up as a horizontal line at the bottom of the cell.

 

Restrictions

 

See also

 

Console Module, Console_SetCursorPosition, Console_SetCursorSize

 

Examples

 

Console_WriteLine("The cursor size is " + Console_GetCursorSize())