FillConsoleOutputCharacter
The FillConsoleOutputCharacter
function writes a character to the screen buffer a specified number of times,
beginning at the specified coordinates.
BOOL FillConsoleOutputCharacter(
|
HANDLE hConsoleOutput, |
// handle to screen
buffer |
|
TCHAR cCharacter, |
// character to
write |
|
DWORD nLength, |
// number of
character cells to write to |
|
COORD dwWriteCoord, |
// x- and
y-coordinates of first cell |
|
LPDWORD lpNumberOfCharsWritten |
// pointer to
number of cells written to |
|
); |
|
Parameters
hConsoleOutput
Identifies a
screen buffer. The handle must have GENERIC_WRITE access.
cCharacter
Specifies the
character to write to the screen buffer.
nLength
Specifies the
number of character cells to write the character to.
dwWriteCoord
Specifies a COORD structure containing the
screen buffer coordinates of the first cell to write the character to.
lpNumberOfCharsWritten
Points to the
variable that receives the number of characters actually written to the screen
buffer.
Return Values
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 characters to write to extends beyond the end of the specified row in the
screen buffer, characters are written to the next row. If the number of characters
to write to extends beyond the end of the screen buffer, the characters are written
up to the end of the screen buffer.
The attribute
values at the positions written are not changed.
Windows
NT: This function uses either Unicode
characters or 8-bit characters from the console's current codepage. The
console's codepage defaults initially to the system's OEM codepage. To change
the console's codepage, use the SetConsoleCP or SetConsoleOutputCP
functions, or use the chcp or mode con cp select= commands.
See Also