Retrieves information about the size and visibility of the cursor for the specified console screen buffer.
Syntax
BOOL WINAPI GetConsoleCursorInfo(
_In_ HANDLE hConsoleOutput,
_Out_ PCONSOLE_CURSOR_INFO lpConsoleCursorInfo
);
Parameters
hConsoleOutput [in]
A handle to the console screen buffer. The handle must have the GENERIC_READ access right. For more information, see Console Buffer Security and Access Rights.
lpConsoleCursorInfo [out]
A pointer to a CONSOLE_CURSOR_INFO structure that receives information about the console's cursor.
Return value
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.
Requirements
Minimum supported client |
Windows 2000 Professional [desktop apps only] |
Minimum supported server |
Windows 2000 Server [desktop apps only] |
Header |
Wincon.h (include Windows.h) |
Library |
Kernel32.lib |
DLL |
Kernel32.dll |