Export (0) Print
Expand All

SetConsoleCursorInfo function

Sets the size and visibility of the cursor for the specified console screen buffer.

Syntax


BOOL WINAPI SetConsoleCursorInfo(
  _In_  HANDLE hConsoleOutput,
  _In_  const CONSOLE_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 [in]

A pointer to a CONSOLE_CURSOR_INFO structure that provides the new specifications for the console screen buffer'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

When a screen buffer's cursor is visible, its appearance can vary, ranging from completely filling a character cell to showing up as a horizontal line at the bottom of the cell. The dwSize member of the CONSOLE_CURSOR_INFO structure specifies the percentage of a character cell that is filled by the cursor. If this member is less than 1 or greater than 100, SetConsoleCursorInfo fails.

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
GetConsoleCursorInfo
SetConsoleCursorPosition

 

 

Community Additions

ADD
Show:
© 2015 Microsoft