|
Overview |
|
|
|
Group |
|
|
|
Quick Info
Windows NT
| Yes
| Win95
| Yes
| Win32s
| No
| Import Library
| kernel32.lib
| Header File
| winbase.h
| Unicode
| WinNT
| Platform Notes
| None
|
|
|
GetNamedPipeHandleState
The GetNamedPipeHandleState function retrieves information about a specified named pipe. The information
returned can vary during the lifetime of an instance of the named pipe.
BOOL GetNamedPipeHandleState(
HANDLE hNamedPipe,
| // handle of named pipe
| LPDWORD lpState,
| // address of flags indicating pipe state
| LPDWORD lpCurInstances,
| // address of number of current pipe instances
| LPDWORD lpMaxCollectionCount,
| // address of max. bytes before remote transmission
| LPDWORD lpCollectDataTimeout,
| // address of max. time before remote transmission
| LPTSTR lpUserName,
| // address of user name of client process
| DWORD nMaxUserNameSize
| // size, in characters, of user name buffer
| );
|
|
Parameters
hNamedPipe
Identifies the named pipe for which information is wanted. The handle must
have GENERIC_READ access to the named pipe.
lpState
Points to a 32-bit variable that indicates the current state of the handle.
This parameter can be NULL if this information is not needed. Either or both of
the following values can be specified:
Value
| Meaning
| PIPE_NOWAIT
| The pipe handle is in nonblocking mode. If this flag is not specified, the
pipe handle is in blocking mode.
| PIPE_READMODE_MESSAGE
| The pipe handle is in message-read mode. If this flag is not specified, the
pipe handle is in byte-read mode.
|
lpCurInstances
Points to a 32-bit variable that receives the number of current pipe
instances. This parameter can be NULL if this information is not required.
lpMaxCollectionCount
Points to a 32-bit variable that receives the maximum number of bytes to be
collected on the client's 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 computer. This parameter
can be NULL if this information is not required.
lpCollectDataTimeout
Points to a 32-bit variable that receives 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 can be NULL if this information is not required.
lpUserName
Points to a buffer that receives the null-terminated string containing the
user name string of the client application. This parameter must be NULL if the
specified pipe handle is to the client end of a named pipe. This parameter can be
NULL if this information is not required.
nMaxUserNameSize
Specifies the size, in characters, of the buffer specified by the lpUserName parameter. This parameter is ignored if lpUserName is NULL.
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
The GetNamedPipeHandleState function returns successfully even if all of the pointers passed to it are
NULL.
To set the pipe handle state, use the SetNamedPipeHandleState function.
See Also
SetNamedPipeHandleState
| 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
|
