WriteConsoleOutputAttribute function (Windows)

Applies to: desktop apps only

Copies a number of character attributes to consecutive cells of a console screen buffer, beginning at a specified location.

Syntax

BOOL WINAPI WriteConsoleOutputAttribute(
  __in   HANDLE hConsoleOutput,
  __in   const WORD *lpAttribute,
  __in   DWORD nLength,
  __in   COORD dwWriteCoord,
  __out  LPDWORD lpNumberOfAttrsWritten
);

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.

lpAttribute [in]

The attributes to be used when writing to the console screen buffer. For more information, see Character Attributes.

nLength [in]

The number of screen buffer character cells to which the attributes will be copied.

The storage for this buffer is allocated from a shared heap for the process that is 64 KB in size. The maximum size of the buffer will depend on heap usage.

dwWriteCoord [in]

A COORD structure that specifies the character coordinates of the first cell in the console screen buffer to which the attributes will be written.

lpNumberOfAttrsWritten [out]

A pointer to a variable that receives the number of attributes actually written 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

If the number of attributes to be written to extends beyond the end of the specified row in the console screen buffer, attributes are written to the next row. If the number of attributes to be written to extends beyond the end of the console screen buffer, the attributes are written up to the end of the console screen buffer.

The character values at the positions written to are not changed.

Requirements

See also

Console Functions

COORD

Low-Level Console Output Functions

ReadConsoleOutput

ReadConsoleOutputAttribute

ReadConsoleOutputCharacter

WriteConsoleOutput

WriteConsoleOutputCharacter

Send comments about this topic to Microsoft

Build date: 2/3/2012