getconsolecursorinfo.md

title	description	author	ms.author	ms.topic	keywords	f1_keywords	MS-HAID	MSHAttr	ms.assetid	topic_type	api_name	api_location	api_type
GetConsoleCursorInfo function	Retrieves information about the size and visibility of the cursor for the specified console screen buffer.	miniksa	miniksa	article	console, character mode applications, command line applications, terminal applications, console api	consoleapi2/GetConsoleCursorInfo wincon/GetConsoleCursorInfo GetConsoleCursorInfo	\_win32\_getconsolecursorinfo base.getconsolecursorinfo consoles.getconsolecursorinfo	PreferredSiteName:MSDN PreferredLib:/library/windows/desktop	6200577d-8d84-46bd-9330-d0b6cbbb3e52	apiref	GetConsoleCursorInfo	Kernel32.dll API-MS-Win-Core-Console-l2-1-0.dll KernelBase.dll API-MS-Win-DownLevel-Kernel32-l1-1-0.dll	DllExport

GetConsoleCursorInfo function

[!INCLUDE not-recommended-banner]

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.

Remarks

[!INCLUDE no-vt-equiv-user-priv]

Requirements

Minimum supported client	Windows 2000 Professional [desktop apps only]
Minimum supported server	Windows 2000 Server [desktop apps only]
Header	ConsoleApi2.h (via WinCon.h, include Windows.h)
Library	Kernel32.lib
DLL	Kernel32.dll

See also

Console Functions

Console Screen Buffers

CONSOLE_CURSOR_INFO

SetConsoleCursorInfo