На главную

On-line справка по Win32 API

Написать письмо
БЕСПЛАТНАЯ ежедневная online лотерея! Выигрывай каждый день БЕСПЛАТНО!
Список всех статей A-B-C-D-E-F-G-H-I-J-K-L-M-N-O-P-Q-R-S-T-U-V-W-X-Y-Z | Скачать Вниз

PeekNamedPipe



The PeekNamedPipe function copies data from a named or anonymous pipe into a buffer without removing it from the pipe. It also returns information about data in the pipe.

BOOL PeekNamedPipe(

HANDLE hNamedPipe, // handle to pipe to copy from
LPVOID lpBuffer, // pointer to data buffer
DWORD nBufferSize, // size, in bytes, of data buffer
LPDWORD lpBytesRead, // pointer to number of bytes read
LPDWORD lpTotalBytesAvail, // pointer to total number of bytes available
LPDWORD lpBytesLeftThisMessage // pointer to unread bytes in this message
);


Parameters

hNamedPipe

Identifies the pipe. This parameter can be a handle to a named pipe instance, as returned by the CreateNamedPipe or CreateFile function, or it can be a handle to the read end of an anonymous pipe, as returned by the CreatePipe function. The handle must have GENERIC_READ access to the pipe.

lpBuffer

Points to a buffer that receives data read from the pipe. This parameter can be NULL if no data is to be read.

nBufferSize

Specifies the size, in bytes, of the buffer specified by the lpBuffer parameter. This parameter is ignored if lpBuffer is NULL.

lpBytesRead

Points to a 32-bit variable that receives the number of bytes read from the pipe. This parameter can be NULL if no data is to be read.

lpTotalBytesAvail

Points to a 32-bit variable that receives the total number of bytes available to be read from the pipe. This parameter can be NULL if no data is to be read.

lpBytesLeftThisMessage

Points to a 32-bit variable that receives the number of bytes remaining in this message. This parameter will be zero for byte-type named pipes or for anonymous pipes. This parameter can be NULL if no data is to be read.



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

PeekNamedPipe is similar to the ReadFile function with the following exceptions:

· The data read from the pipe is not removed from the pipe's buffer.
· The function always returns immediately, even if there is no data in the pipe. The wait mode of a named pipe handle (blocking or nonblocking) has no effect on the function.
· The function can return additional information about the contents of the pipe.



If the specified handle is a named pipe handle in byte-read mode, the function reads all available bytes up to the size specified in nBufferSize. For a named pipe handle in message-read mode, the function reads the next message in the pipe. If the message is larger than nBufferSize, the function returns TRUE after reading the specified number of bytes. In this situation, lpBytesLeftThisMessage will receive the number of bytes remaining in the message.

See Also

CreateFile, CreateNamedPipe, CreatePipe, ReadFile, WriteFile


Пригласи друзей и счет твоего мобильника всегда будет положительным!
Предыдущая статья
 
Сайт Народ.Ру Интернет
Следующая статья
Пригласи друзей и счет твоего мобильника всегда будет положительным!

PeekNamedPipe



Функция PeekNamedPipe копирует данные из поименованной или анонимной трубы в буфер не удаляя это из трубы. Это также возвращает информацию о данных в трубе.

BOOL PeekNamedPipe(

РУЧКА hNamedPipe, // оперируется в трубу, чтобы копироваться из LPVOID lpBuffer, // указатель в буфер данных DWORD nBufferSize, // размер, в байтах, буфера данных LPDWORD lpBytesRead, // указатель в количество байтов был прочитан LPDWORD lpTotalBytesAvail, // указатель в общее число байтов доступный lpBytesLeftThisMessage / LPDWORD/ указатель в unread байты в этом сообщении
);


Параметры

hNamedPipe

Идентифицирует трубу. Этот параметр может быть ручкой в поименованном примере трубы, как возвращано CreateNamedPipe или функцией CreateFile, или это может быть ручкой в конце чтения анонимной трубы, как возвращано функцией CreatePipe. Ручка должна иметь доступ GENERIC_READ к трубе.

lpBuffer

Точки на буфер, которые получают данные был прочитан из трубы. Этот параметр может быть НЕДЕЙСТВИТЕЛЕН если никакие данные не должны быть прочитаны.

nBufferSize

Определяет размер, в байтах, буфера определенного параметром lpBuffer. Этот параметр проигнорирован если lpBuffer НЕДЕЙСТВИТЕЛЕН.

lpBytesRead

Точки на 32- битовую переменную, которые получают количество байтов прочитанных из трубы. Этот параметр может быть НЕДЕЙСТВИТЕЛЕН если никакие данные не должны быть прочитаны.

lpTotalBytesAvail

Точки на 32- битовую переменную, которые получают общее число байтов доступных быть прочитанн из трубы. Этот параметр может быть НЕДЕЙСТВИТЕЛЕН если никакие данные не должны быть прочитаны.

lpBytesLeftThisMessage

Точки на 32- битовую переменную, которые получают количество байтов, остающихся в этом сообщении. Этот параметр будет нулем для байтового-типа назвавшего трубы или для анонимных труб. Этот параметр может быть НЕДЕЙСТВИТЕЛЕН если никакие данные не должны быть прочитаны.



Обратные Величины

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

Замечания

PeekNamedPipe ПОДОБНЫЙ функции ReadFile с следующими исключениями:

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



Если определенная ручка является поименованной ручкой трубы в байте-прочитавшем режим, функция читает все доступные байты вплоть до размера определенного в nBufferSize. Для поименованной ручки трубы в сообщении-прочитавшем режим, функция читает следующее сообщение в трубе. Если сообщение большее чем nBufferSize, функция возвращает ИСТИНУ после чтения определенного количества байтов. В этой ситуации, lpBytesLeftThisMessage получит количество байтов, остающихся в сообщении.

Смотри Также

CreateFile, CreateNamedPipe, CreatePipe, ReadFile, WriteFile


Вверх Version 1.3, Oct 26 2010 © 2007, 2010, mrhx Вверх
 mrhx software  Русский перевод OpenGL  Русский перевод Win32 API
 
Используются технологии uCoz