FillConsoleOutputAttribute function

Sets the character attributes for a specified number of character cells, beginning at the specified coordinates in a screen buffer.

Syntax


BOOL WINAPI FillConsoleOutputAttribute(
  _In_   HANDLE hConsoleOutput,
  _In_   WORD wAttribute,
  _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.

wAttribute [in]

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

nLength [in]

The number of character cells to be set to the specified color attributes.

dwWriteCoord [in]

A COORD structure that specifies the character coordinates of the first cell whose attributes are to be set.

lpNumberOfAttrsWritten [out]

A pointer to a variable that receives the number of character cells whose attributes were actually set.

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 character cells whose attributes are to be set extends beyond the end of the specified row in the console screen buffer, the cells of the next row are set. If the number of cells to write to extends beyond the end of the console screen buffer, the cells are written up to the end of the console screen buffer.

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

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
COORD
FillConsoleOutputCharacter
Low-Level Console Output Functions
SetConsoleTextAttribute
WriteConsoleOutputAttribute

 

 

Community Additions

ADD
Show:
© 2014 Microsoft