CONSOLE_SCREEN_BUFFER_INFO structure (Windows)

Applies to: desktop apps only

Contains information about a console screen buffer.

Syntax

typedef struct _CONSOLE_SCREEN_BUFFER_INFO {
  COORD      dwSize;
  COORD      dwCursorPosition;
  WORD       wAttributes;
  SMALL_RECT srWindow;
  COORD      dwMaximumWindowSize;
} CONSOLE_SCREEN_BUFFER_INFO;

Members

dwSize

A COORD structure that contains the size of the console screen buffer, in character columns and rows.

dwCursorPosition

A COORD structure that contains the column and row coordinates of the cursor in the console screen buffer.

wAttributes

The attributes of the characters written to a screen buffer by the WriteFile and WriteConsole functions, or echoed to a screen buffer by the ReadFile and ReadConsole functions. For more information, see Character Attributes.

srWindow

A SMALL_RECT structure that contains the console screen buffer coordinates of the upper-left and lower-right corners of the display window.

dwMaximumWindowSize

A COORD structure that contains the maximum size of the console window, in character columns and rows, given the current screen buffer size and font and the screen size.

Examples

For an example, see Scrolling a Screen Buffer's Contents.

Requirements

See also

COORD

GetConsoleScreenBufferInfo

ReadConsole

ReadFile

SMALL_RECT

WriteConsole

WriteFile

Send comments about this topic to Microsoft

Build date: 2/3/2012