Функция ReadConsoleOutputCharacter

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

Синтаксис

BOOL ReadConsoleOutputCharacter(

HANDLE hConsoleOutput,      // дескриптор экранного буфера
LPTSTR
lpCharacter,         // символьный буфер
DWORD
nLength,              // число ячеек для чтения
COORD
dwReadCoord,          // координаты первой ячейки
LPDWORD
lpNumberOfCharsRead // число прочитанных ячеек

);

Параметры

hConsoleOutput

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

lpCharacter

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

nLength

[in] Число символьных знакомест экранного буфера для чтения. Размер буфера, указанного параметром lpCharacter должен быть nLength * sizeof (TCHAR).

dwReadCoord

[in] Координаты первой ячейки для чтения в экранном буфере консоли. Член X структуры COORD - это колонка, а член Y - строка.

lpNumberOfCharsRead

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

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

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

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

Замечания

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

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

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

Смотри также

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

Размещение и совместимость ReadConsoleOutputCharacter

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

Замечания по платформе

Не имеется

 

Назад в оглавление
На главную страницу
На оглавление справки

Hosted by uCoz