SetConsoleActiveScreenBuffer function (Windows)

Applies to: desktop apps only

Sets the specified screen buffer to be the currently displayed console screen buffer.

Syntax

BOOL WINAPI SetConsoleActiveScreenBuffer(
  __in  HANDLE hConsoleOutput
);

Parameters

hConsoleOutput [in]

A handle to the console screen buffer.

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

A console can have multiple screen buffers. SetConsoleActiveScreenBuffer determines which one is displayed. You can write to an inactive screen buffer and then use SetConsoleActiveScreenBuffer to display the buffer's contents.

Examples

For an example, see Reading and Writing Blocks of Characters and Attributes.

Requirements

See also

Console Functions

Console Screen Buffers

CreateConsoleScreenBuffer

Send comments about this topic to Microsoft

Build date: 2/3/2012