Permalink
Find file
Fetching contributors…
Cannot retrieve contributors at this time
120 lines (92 sloc) 2.99 KB
title description author ms.author ms.topic ms.prod keywords MS-HAID MSHAttr ms.assetid topic_type api_name api_location api_type
SetConsoleScreenBufferSize function
Changes the size of the specified console screen buffer.
bitcrazed
richturn
article
console
console, character mode applications, command line applications, terminal applications, console api
\_win32\_setconsolescreenbuffersize
base.setconsolescreenbuffersize
consoles.setconsolescreenbuffersize
PreferredSiteName:MSDN
PreferredLib:/library/windows/desktop
50bf1973-5604-42fe-bbeb-611ddc240bdd
apiref
SetConsoleScreenBufferSize
Kernel32.dll
API-MS-Win-Core-Console-l2-1-0.dll
KernelBase.dll
API-MS-Win-DownLevel-Kernel32-l1-1-0.dll
DllExport

SetConsoleScreenBufferSize function

Changes the size of the specified console screen buffer.

Syntax

BOOL WINAPI SetConsoleScreenBufferSize(
  _In_ HANDLE hConsoleOutput,
  _In_ COORD  dwSize
);

Parameters

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

dwSize [in]
A COORD structure that specifies the new size of the console screen buffer, in character rows and columns. The specified width and height cannot be less than the width and height of the console screen buffer's window. The specified dimensions also cannot be less than the minimum size allowed by the system. This minimum depends on the current font size for the console (selected by the user) and the SM_CXMIN and SM_CYMIN values returned by the GetSystemMetrics function.

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 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Wincon.h (include Windows.h)

Library

Kernel32.lib

DLL

Kernel32.dll

See also

Console Functions

Console Input Buffer

COORD

GetConsoleScreenBufferInfo

SetConsoleWindowInfo