|
Overview |
|
|
|
Group |
|
|
|
Quick Info
Windows NT
| Yes
| Win95
| Yes
| Win32s
| No
| Import Library
| kernel32.lib
| Header File
| winbase.h
| Unicode
| WinNT
| Platform Notes
| None
|
|
|
CallNamedPipe
The CallNamedPipe function connects to a message-type pipe (and waits if an instance of the
pipe is not available), writes to and reads from the pipe, and then closes the
pipe.
BOOL CallNamedPipe(
LPCTSTR lpNamedPipeName,
| // pointer to pipe name
| LPVOID lpInBuffer,
| // pointer to write buffer
| DWORD nInBufferSize,
| // size, in bytes, of write buffer
| LPVOID lpOutBuffer,
| // pointer to read buffer
| DWORD nOutBufferSize,
| // size, in bytes, of read buffer
| LPDWORD lpBytesRead,
| // pointer to number of bytes read
| DWORD nTimeOut
| // time-out time, in milliseconds
| );
|
|
Parameters
lpNamedPipeName
Pointer to a null-terminated string specifying the pipe name.
lpInBuffer
Pointer to the buffer containing the data written to the pipe.
nInBufferSize
Specifies the size, in bytes, of the write buffer.
lpOutBuffer
Pointer to the buffer that receives the data read from the pipe.
nOutBufferSize
Specifies the size, in bytes, of the read buffer.
lpBytesRead
Pointer to a 32-bit variable that receives the number of bytes read from the
pipe.
nTimeOut
Specifies the number of milliseconds to wait for the named pipe to be
available. In addition to numeric values, the following special values can be
specified:
Value
| Meaning
| NMPWAIT_NOWAIT
| Does not wait for the named pipe. If the named pipe is not available, the
function returns an error.
| NMPWAIT_WAIT_FOREVER
| Waits indefinitely.
| NMPWAIT_USE_DEFAULT_WAIT
| Uses the default time-out specified in a call to the CreateNamedPipe function.
|
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
Calling CallNamedPipe is equivalent to calling the CreateFile (or WaitNamedPipe, if CreateFile cannot open the pipe immediately), TransactNamedPipe, and CloseHandle functions. CreateFile is called with an access flag of GENERIC_READ | GENERIC_WRITE, an inherit
handle flag of FALSE, and a share mode of zero (indicating no sharing of this pipe
instance).
If the message written to the pipe by the server process is longer than nOutBufferSize, CallNamedPipe returns FALSE, and GetLastError returns ERROR_MORE_DATA. The remainder of the message is discarded, because CallNamedPipe closes the handle to the pipe before returning.
CallNamedPipe fails if the pipe is a byte-type pipe.
See Also
CloseHandle, CreateFile, CreateNamedPipe, TransactNamedPipe, WaitNamedPipe
| 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
|
