* * 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
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
Name |
Type |
Optional |
Meaning |
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())
