Skip to content

Latest commit

 

History

History
83 lines (63 loc) · 3.23 KB

setconsolescreenbufferinfoex.md

File metadata and controls

83 lines (63 loc) · 3.23 KB
title description author ms.author ms.topic keywords f1_keywords MS-HAID MSHAttr ms.assetid topic_type api_name api_location api_type
SetConsoleScreenBufferInfoEx function
Sets extended information about the specified console screen buffer to the specified buffer.
miniksa
miniksa
article
console, character mode applications, command line applications, terminal applications, console api
consoleapi2/SetConsoleScreenBufferInfoEx
wincon/SetConsoleScreenBufferInfoEx
SetConsoleScreenBufferInfoEx
base.setconsolescreenbufferinfoex
consoles.setconsolescreenbufferinfoex
PreferredSiteName:MSDN
PreferredLib:/library/windows/desktop
ff851144-eee9-4410-8fd1-28aa24fc25f1
apiref
SetConsoleScreenBufferInfoEx
Kernel32.dll
API-MS-Win-Core-Console-l2-1-0.dll
KernelBase.dll
API-MS-Win-DownLevel-Kernel32-l1-1-0.dll
DllExport

SetConsoleScreenBufferInfoEx function

[!INCLUDE not-recommended-banner]

Sets extended information about the specified console screen buffer.

Syntax

BOOL WINAPI SetConsoleScreenBufferInfoEx(
  _In_ HANDLE                        hConsoleOutput,
  _In_ PCONSOLE_SCREEN_BUFFER_INFOEX lpConsoleScreenBufferInfoEx
);

Parameters

hConsoleOutput [in]
A handle to the console screen buffer. The handle must have the GENERIC_WRITE access right. For more information, see Console Buffer Security and Access Rights.

lpConsoleScreenBufferInfoEx [in]
A CONSOLE_SCREEN_BUFFER_INFOEX structure that contains the console screen buffer information.

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

Tip

This API has a partial virtual terminal equivalent. Cursor positioning buffer and text attributes have specific sequence equivalents. The color table is not configurable, but extended colors are available beyond what is normally available through console functions. Popup attributes have no equivalent as popup menus are the responsibility of the command-line client application in the virtual terminal world. Finally, the size of the window and the full screen status are considered privileges owned by the user in the virtual terminal world and have no equivalent sequence.

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)
Library Kernel32.lib
DLL Kernel32.dll

See also

Console Functions

CONSOLE_SCREEN_BUFFER_INFOEX

GetConsoleScreenBufferInfoEx