Skip to content

Latest commit

 

History

History
98 lines (76 loc) · 3.6 KB

console-screen-buffer-infoex.md

File metadata and controls

98 lines (76 loc) · 3.6 KB
title description author ms.author ms.topic keywords f1_keywords MS-HAID MSHAttr ms.assetid topic_type api_name api_location api_type
CONSOLE_SCREEN_BUFFER_INFOEX structure
See reference information about the CONSOLE_SCREEN_BUFFER_INFOEX structure, which contains extended information about a console screen buffer.
miniksa
miniksa
article
console, character mode applications, command line applications, terminal applications, console api
consoleapi2/CONSOLE_SCREEN_BUFFER_INFOEX
wincon/CONSOLE_SCREEN_BUFFER_INFOEX
CONSOLE_SCREEN_BUFFER_INFOEX
consoleapi2/PCONSOLE_SCREEN_BUFFER_INFOEX
wincon/PCONSOLE_SCREEN_BUFFER_INFOEX
PCONSOLE_SCREEN_BUFFER_INFOEX
base.console\_screen\_buffer\_infoex
consoles.console\_screen\_buffer\_infoex
PreferredSiteName:MSDN
PreferredLib:/library/windows/desktop
6ed40df3-063d-41c9-8637-510c95104603
apiref
CONSOLE_SCREEN_BUFFER_INFOEX
WinCon.h
HeaderDef

CONSOLE_SCREEN_BUFFER_INFOEX structure

Contains extended information about a console screen buffer.

Syntax

typedef struct _CONSOLE_SCREEN_BUFFER_INFOEX {
  ULONG      cbSize;
  COORD      dwSize;
  COORD      dwCursorPosition;
  WORD       wAttributes;
  SMALL_RECT srWindow;
  COORD      dwMaximumWindowSize;
  WORD       wPopupAttributes;
  BOOL       bFullscreenSupported;
  COLORREF   ColorTable[16];
} CONSOLE_SCREEN_BUFFER_INFOEX, *PCONSOLE_SCREEN_BUFFER_INFOEX;

Members

cbSize
The size of this structure, in bytes.

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.

wPopupAttributes
The fill attribute for console pop-ups.

bFullscreenSupported
If this member is TRUE, full-screen mode is supported; otherwise, it is not. This will always be FALSE for systems after Windows Vista with the WDDM driver model as true direct VGA access to the monitor is no longer available.

ColorTable
An array of COLORREF values that describe the console's color settings.

Requirements

   
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Header ConsoleApi2.h (via WinCon.h, include Windows.h)

See also

COORD

GetConsoleScreenBufferInfoEx

SetConsoleScreenBufferInfoEx

SMALL_RECT