GetConsoleCursorInfo Function

Retrieves information about the size and visibility of the cursor for the specified console screen buffer.

Syntax

C++ 
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 clientWindows 2000 Professional
Minimum supported serverWindows 2000 Server
HeaderWincon.h (include Windows.h)
LibraryKernel32.lib
DLLKernel32.dll

See Also

Console Functions
Console Screen Buffers
CONSOLE_CURSOR_INFO
SetConsoleCursorInfo

Send comments about this topic to Microsoft

Build date: 10/8/2009

Tags :


Community Content

dmex
vb.net syntax
<DllImport("kernel32.dll", SetLastError:=True)> _
Public Shared Function GetConsoleCursorInfo(ByVal hConsoleOutput As IntPtr, <Out> ByRef cci As CONSOLE_CURSOR_INFO) As Boolean
End Function
Tags : vb.net syntax

dmex
C# syntax
[DllImport("kernel32.dll", SetLastError=true)]
internal static extern bool GetConsoleCursorInfo(IntPtr hConsoleOutput, out CONSOLE_CURSOR_INFO cci);
Tags : c# syntax

Thomas Lee
Alternative to using unmanaged code API

As an alternative to using this unmanged API in your managed code, consider looking at the System.Windows.Forms.Cursor class. See http://msdn.microsoft.com/en-us/library/system.windows.forms.cursor(VS.71).aspx for more details of this class.


Page view tracker