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 screen buffer
  PCONSOLE_CURSOR_INFO lpConsoleCursorInfo  // cursor information
);

Parameters

hConsoleOutput

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

lpConsoleCursorInfo

[out] 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.

Requirements

  Windows NT/2000: Requires Windows NT 3.1 or later.
  Windows 95/98: Requires Windows 95 or later.
  Header: Declared in Wincon.h; include Windows.h.
  Library: Use Kernel32.lib.

See Also

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