|
Overview |
|
|
|
Group |
|
|
|
Quick Info
Windows NT
| Yes
| Win95
| Yes
| Win32s
| No
| Import Library
| kernel32.lib
| Header File
| winbase.h
| Unicode
| No
| Platform Notes
| None
|
|
|
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
| Last news from Greatis Software |
 |
|
Nostalgia .Net |
|
.Net is powerful, but not all-powerful, so sometimes we need to use Win32 API for our .Net applications. It's simple enough with Platform Invoke if you have Win32 skill, but we do not always have time to dig the ancient documentation, declare the special types that are compatible with Win32, find the values of the Win32's constants and so on. Nostalgia .Net offers several simple-to-use classes, and components that will allow you to forget about the headache of Win32 and just use the power of Win32 in your application the same way as you use the native. Net classes. More » |
| Recommended software for developers |
 |
|
Ultimate Pack |
|
Component pack for Delphi and C++ Builder that contains runtime form designer, runtime object inspector, print suite and much more for the very special price. More » |
 |
|
Form Designer .Net |
|
Unique runtime form design solution that allows to edit any form in .Net WinForms application at runtime with full source codes for only 300 euro! More » |
 |
|
Print Suite .Net |
|
Print Suite .Net is a set of components for easy printing texts, images and grids from your WinForms applications. Full C# source codes are available More » |
 |
|
Gradient Controls .Net |
|
Gradient Controls .Net offers controls with gradient background feature. Labels, panels and so on... Full C# source codes are available More » |
 |
|
Greatis iGrid |
|
iGrid plots drawing grid right over your desktop, so you can use it everywhere, with any drawing application without any special plugins for different graphic editors. More » |
All the contacts and projectsDmitry Vasiliev (just.dmitry)
Related LinksSoftware for Visual Studio .NET developers
Software for Delphi and C++ Builder developers
Software for Visual Basic 6 developers
Delphi Tips&Tricks
MegaDetailed.NET More Online Helps Win32 Programmer's Reference
Win32 Multimedia Programmer's Reference
OLE Programmer's Reference
Microsoft Windows Pen API Programmer's Reference
Microsoft Windows Sockets 2 Reference
Microsoft Windows Telephony API (TAPI) Programmer's Reference
Unix Manual Pages
|
