Upgrade your Internet Experience
Microsoft.com
Welcome Sign in
Windows Developer Center
Click to Rate and Give Feedback
MSDN
MSDN Library
System Services
Console Reference
Console Functions
 GetConsoleCursorInfo Function
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: 11/19/2009

Tags What's this?: Add a tag
Community Content   What is Community Content?
Add new content RSS  Annotations
vb.net syntax      dmex   |   Edit   |   Show History 
<DllImport("kernel32.dll", SetLastError:=True)> _
Public Shared Function GetConsoleCursorInfo(ByVal hConsoleOutput As IntPtr, <Out> ByRef cci As CONSOLE_CURSOR_INFO) As Boolean
End Function
Flag as ContentBug
C# syntax      dmex   |   Edit   |   Show History 
[DllImport("kernel32.dll", SetLastError=true)]
internal static extern bool GetConsoleCursorInfo(IntPtr hConsoleOutput, out CONSOLE_CURSOR_INFO cci);
Tags What's this?: c# (x) syntax (x) Add a tag
Flag as ContentBug
Alternative to using unmanaged code API      Thomas Lee   |   Edit   |   Show History

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.

© 2009 Microsoft Corporation. All rights reserved. Terms of Use | Trademarks | Privacy Statement
Page view tracker