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

 

 

Community Additions

ADD
Show:
© 2014 Microsoft