Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
113 lines (88 sloc) 2.62 KB
title description author ms.author ms.topic 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.
bitcrazed
richturn
article
console, character mode applications, command line applications, terminal applications, console api
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

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.

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

 

 

You can’t perform that action at this time.