SetConsoleCursorInfo
The SetConsoleCursorInfo
function sets the size and visibility of the cursor for the specified console
screen buffer.
BOOL SetConsoleCursorInfo(
|
HANDLE hConsoleOutput, |
// handle of
console screen buffer |
|
CONST CONSOLE_CURSOR_INFO *lpConsoleCursorInfo |
// address of
cursor information |
|
); |
|
Parameters
hConsoleOutput
Identifies a
console screen buffer. The handle must have GENERIC_WRITE access.
lpConsoleCursorInfo
Points to a CONSOLE_CURSOR_INFO structure containing the
new specifications for the screen buffer s cursor.
Return Values
If the
function succeeds, the return value is nonzero.
If the
function fails, the return value is zero. To get extended error information,
call GetLastError.
Remarks
When a screen
buffer s cursor is visible, its appearance can vary, ranging from completely
filling a character cell to showing up as a horizontal line at the bottom of
the cell. The dwSize member of the CONSOLE_CURSOR_INFO structure
specifies the percentage of a character cell that is filled by the cursor. If
this member is less than 1 or greater than 100, SetConsoleCursorInfo
fails.
See Also