Permalink
Fetching contributors…
Cannot retrieve contributors at this time
118 lines (91 sloc) 2.66 KB
title description author ms.author ms.topic ms.prod 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.
bitcrazed
richturn
article
console
console, character mode applications, command line applications, terminal applications, console api
\_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

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

See also

Console Functions

Console Screen Buffers

CONSOLE_CURSOR_INFO

SetConsoleCursorInfo