Функция WriteConsoleOutputCharacter

Функция WriteConsoleOutputCharacter

Функция WriteConsoleOutputCharacter копирует ряд символов в последовательные ячейки экранного буфера консоли, начинающиеся в заданном месте.

Синтаксис

BOOL WriteConsoleOutputCharacter(

HANDLEhConsoleOutpu,           // дескриптор экранного буфера
LPCTSTR lpCharacter,           // символы
DWORD nLength,                 // число символов для записи
COORD dwWriteCoord,            // координаты первой ячейки
LPDWORD lpNumberOfCharsWritten // число записанных ячеек

);

Параметры

hConsoleOutput

[in] Дескриптор экранного буфера консоли. Дескриптор должен иметь право доступа GENERIC_READ. Для получения дополнительной информации, см. статью Защита буфера и права доступа в консоли.

lpCharacter

[in] Указатель на буфер, который содержит символы, для записи в экранный буфер консоли. Общий размер должен быть меньше чем 64КБ.

nLength

[in] Число TCHARs, которые будут записаны.

dwWriteCoord

[in] Структура COORD, которая устанавливает координаты первой ячейки в экранном буфере консоли в которые символы должны быть записаны.

lpNumberOfCharsWritten

[out] Указатель на переменную, которая получает число фактически записанных TCHARs.

Возвращаемые значения

Если функция завершается успешно, величина возвращаемого значения - не ноль.

Если функция завершается с ошибкой, величина возвращаемого значения - ноль. Чтобы получать расширенные данные об ошибках, вызовите функцию GetLastError.

Замечания

Если число символов, которое будет записано выходит за пределы конца заданного ряда в экранном буфере консоли, символы записываются в следующем ряду. Если число символов, которое будет записано выходит за пределы конца экранного буфера консоли, символы записываются до конца экранного буфера консоли.

Значения атрибута в позициях записи не изменяются.

Windows NT /2000/XP: эта функция использует или символы Unicode или 8-разрядные символы из текущей кодовой страницы консоли. Кодовая страница консоли вначале устанавливается по умолчанию как системная кодовая страница (OEM). Чтобы изменить кодовую страницу консоли, используйте функции SetConsoleCP или SetConsoleOutputCP, или используйте команды chcp или mode con cp select =.

Windows 95/98/Me: функция WriteConsoleOutputCharacterW поддерживает Microsoft Layer for Unicode. Чтобы использовать его, Вы должны добавить некоторые файлы к вашему приложению, как изложено в Microsoft Layer for Unicode для систем Windows 95/98/Me.

Код примера

Пример смотри в статье Запись символов или цветов в последовательные ячейки

Смотри также

Обзор консольных приложений, Функции консоли, COORD, ReadConsoleOutput, ReadConsoleOutputAttribute, ReadConsoleOutputCharacter, SetConsoleCP, SetConsoleOutputCP, WriteConsoleOutput, WriteConsoleOutputAttribute

Размещение и совместимость WriteConsoleOutputCharacter
Windows. NET Server	Да
Windows XP	Да
Windows 2000	Да
Windows NT	Да
Windows Me	Да
Windows 98	Да
Windows 95	Да
Используемая библиотека	Kernel32.lib
Заголовочный файл
- объявлено в	Wincon.h
- включено в	Windows.h
Unicode	Реализуется как Unicode и ANSI в версиях Windows NT/2000/XP. А также поддерживает Microsoft Layer for Unicode
Замечания по платформе	Не имеется

Назад в оглавление

На главную страницу

На оглавление справки