CONSOLE_CURSOR_INFO structure

Important

This document describes console platform functionality that is no longer a part of our ecosystem roadmap. We do not recommend using this content in new products, but we will continue to support existing usages for the indefinite future. Our preferred modern solution focuses on virtual terminal sequences for maximum compatibility in cross-platform scenarios. You can find more information about this design decision in our classic console vs. virtual terminal document.

Contains information about the console cursor.

Syntax

typedef struct _CONSOLE_CURSOR_INFO {
  DWORD dwSize;
  BOOL  bVisible;
} CONSOLE_CURSOR_INFO, *PCONSOLE_CURSOR_INFO;

Members

dwSize
The percentage of the character cell that is filled by the cursor. This value is between 1 and 100. The cursor appearance varies, ranging from completely filling the cell to showing up as a horizontal line at the bottom of the cell.

Note

While the dwSize value is normally between 1 and 100, under some circumstances a value outside of that range might be returned. For example, if CursorSize is set to 0 in the registry, the dwSize value returned would be 0.

 bVisible
The visibility of the cursor. If the cursor is visible, this member is TRUE.

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)

See also

GetConsoleCursorInfo

SetConsoleCursorInfo