|
Overview |
|
|
|
Group |
|
|
|
Quick Info
Windows NT
| Yes
| Win95
| Yes
| Win32s
| No
| Import Library
| kernel32.lib
| Header File
| winbase.h
| Unicode
| No
| Platform Notes
| None
|
|
|
SetNamedPipeHandleState
The SetNamedPipeHandleState function sets the read mode and the blocking mode of the specified named
pipe. If the specified handle is to the client end of a named pipe and if the named
pipe server process is on a remote computer, the function can also be used to
control local buffering.
BOOL SetNamedPipeHandleState(
HANDLE hNamedPipe,
| // handle of named pipe
| LPDWORD lpMode,
| // address of new pipe mode
| LPDWORD lpMaxCollectionCount,
| // address of max. bytes before remote transmission
| LPDWORD lpCollectDataTimeout
| // address of max. time before remote transmission
| );
|
|
Parameters
hNamedPipe
Identifies the named pipe instance. This parameter can be a handle to the
server end of the pipe, as returned by the CreateNamedPipe function, or to the client end of the pipe, as returned by the CreateFile function. The handle must have GENERIC_WRITE access to the named pipe.
lpMode
Points to a 32-bit variable that supplies the new mode. The mode is a
combination of a read-mode flag and a wait-mode flag. This parameter can be NULL if the
mode is not being set. One of the following read modes can be specified:
Mode
| Description
| PIPE_READMODE_BYTE
| Data is read from the pipe as a stream of bytes. This mode is the default if
no read-mode flag is specified.
| PIPE_READMODE_MESSAGE
| Data is read from the pipe as a stream of messages. The function fails if this
flag is specified for a byte-type pipe.
|
One of the following wait modes can be specified:
Mode
| Description
| PIPE_WAIT
| Blocking mode is enabled. This mode is the default if no wait-mode flag is
specified. When a blocking mode pipe handle is specified in the ReadFile, WriteFile, or ConnectNamedPipe function, operations are not finished until there is data to read, all data
is written, or a client is connected. Use of this mode can mean waiting
indefinitely in some situations for a client process to perform an action.
| PIPE_NOWAIT
| Nonblocking mode is enabled. In this mode, ReadFile, WriteFile, and ConnectNamedPipe always return immediately. Note that nonblocking mode is supported for
compatibility with Microsoft® LAN Manager version 2.0 and should not be used to achieve asynchronous input
and output (I/O) with named pipes.
|
lpMaxCollectionCount
Points to a 32-bit variable that specifies the maximum number of bytes
collected on the client computer before transmission to the server. This parameter
must be NULL if the specified pipe handle is to the server end of a named pipe or
if client and server processes are on the same machine. This parameter is
ignored if the client process specifies the FILE_FLAG_WRITE_THROUGH flag in the CreateFile function when the handle was created. This parameter can be NULL if the
collection count is not being set.
lpCollectDataTimeout
Points to a 32-bit variable that specifies the maximum time, in milliseconds,
that can pass before a remote named pipe transfers information over the
network. This parameter must be NULL if the specified pipe handle is to the server end
of a named pipe or if client and server processes are on the same computer.
This parameter is ignored if the client process specified the
FILE_FLAG_WRITE_THROUGH flag in the CreateFile function when the handle was created. This parameter can be NULL if the
collection count is not being set.
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.
See Also
ConnectNamedPipe, CreateFile, CreateNamedPipe, GetNamedPipeHandleState, 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
|
