GetConsoleScreenBufferInfo function

Retrieves information about the specified console screen buffer.

Syntax


BOOL WINAPI GetConsoleScreenBufferInfo(
  _In_   HANDLE hConsoleOutput,
  _Out_  PCONSOLE_SCREEN_BUFFER_INFO lpConsoleScreenBufferInfo
);

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.

lpConsoleScreenBufferInfo [out]

A pointer to a CONSOLE_SCREEN_BUFFER_INFO structure that receives 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

The rectangle returned in the srWindow member of the CONSOLE_SCREEN_BUFFER_INFO structure can be modified and then passed to the SetConsoleWindowInfo function to scroll the console screen buffer in the window, to change the size of the window, or both.

All coordinates returned in the CONSOLE_SCREEN_BUFFER_INFO structure are in character-cell coordinates, where the origin (0, 0) is at the upper-left corner of the console screen buffer.

Examples

For an example, see Scrolling a Screen Buffer's Window.

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_SCREEN_BUFFER_INFO
GetLargestConsoleWindowSize
SetConsoleCursorPosition
SetConsoleScreenBufferSize
SetConsoleWindowInfo
Window and Screen Buffer Size

 

 

Community Additions

ADD
Show:
© 2014 Microsoft