GetConsoleCursorInfo function
Applies to: desktop apps only
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 |
|---|---|
|
Minimum supported server | Windows 2000 Server |
|
Header |
|
|
Library |
|
|
DLL |
|
See also
Send comments about this topic to Microsoft
Build date: 2/3/2012
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.
- 5/18/2009
- Thomas Lee
[DllImport("kernel32.dll", SetLastError=true)]
internal static extern bool GetConsoleCursorInfo(IntPtr hConsoleOutput, out CONSOLE_CURSOR_INFO cci);
