GetConsoleCursorInfo

The GetConsoleCursorInfo function retrieves information about the size and visibility of the cursor for the specified console screen buffer.

BOOL GetConsoleCursorInfo(
  HANDLE hConsoleOutput,  // handle to console screen buffer
  PCONSOLE_CURSOR_INFO lpConsoleCursorInfo 
                          // address of cursor information
);
 

Parameters

hConsoleOutput

Handle to a console screen buffer. The handle must have GENERIC_READ access.

lpConsoleCursorInfo

Pointer to a CONSOLE_CURSOR_INFO structure in which information about the console's cursor is returned.

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.

QuickInfo

  Windows NT: Requires version 3.1 or later.
  Windows: Requires Windows 95 or later.
  Windows CE: Unsupported.
  Header: Declared in wincon.h.
  Import Library: Use kernel32.lib.

See Also

Consoles and Character-Mode Support Overview, Console Functions, CONSOLE_CURSOR_INFO, SetConsoleCursorInfo