Функция PeekConsoleInput

Функция PeekConsoleInput читает данные из заданного консольного буфера ввода без удаления их из буфера.

Синтаксис

BOOL PeekConsoleInput(

HANDLE hConsoleInput,        // дескриптор консольного 

                        // буфера ввода

PINPUT_RECORD lpBuffer,      // просматриваемые данные

DWORD nLength ,              // число записей для чтения

LPDWORD lpNumberOfEventsRead // число прочитанных записей

);

Параметры

hConsoleInput

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

lpBuffer

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

nLength

[in] Размер массива, указанного параметром lpBuffer, в элементах массива

lpNumberOfEventsRead

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

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

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

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

Замечания

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

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

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

Смотри также

Обзор консольных приложений, Функции консоли, INPUT_RECORD, ReadConsoleInput, SetConsoleCP, SetConsoleOutputCP, WriteConsoleInput

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

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