please dont rip this site Prev Next

GetNamedPipeHandleState info  Overview  Group

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 

See also:


file: /Techref/os/win/api/win32/func/src/f35_7.htm, 5KB, , updated: 2000/4/7 12:19, local time: 2022/5/23 22:31,
TOP NEW HELP FIND: 
18.205.176.39:LOG IN

 ©2022 These pages are served without commercial sponsorship. (No popup ads, etc...).Bandwidth abuse increases hosting cost forcing sponsorship or shutdown. This server aggressively defends against automated copying for any reason including offline viewing, duplication, etc... Please respect this requirement and DO NOT RIP THIS SITE. Questions?
Please DO link to this page! Digg it! / MAKE!

<A HREF="http://www.piclist.com/techref/os/win/api/win32/func/src/f35_7.htm"> GetNamedPipeHandleState</A>

After you find an appropriate page, you are invited to your to this massmind site! (posts will be visible only to you before review) Just type a nice message (short messages are blocked as spam) in the box and press the Post button. (HTML welcomed, but not the <A tag: Instead, use the link box to link to another page. A tutorial is available Members can login to post directly, become page editors, and be credited for their posts.


Link? Put it here: 
if you want a response, please enter your email address: 
Attn spammers: All posts are reviewed before being made visible to anyone other than the poster.
Did you find what you needed?

  PICList 2022 contributors:
o List host: MIT, Site host massmind.org, Top posters @20220523
* Page Editors: James Newton, David Cary, and YOU!
* Roman Black of Black Robotics donates from sales of Linistep stepper controller kits.
* Ashley Roll of Digital Nemesis donates from sales of RCL-1 RS232 to TTL converters.
* Monthly Subscribers: Gregg Rew. on-going support is MOST appreciated!
* Contributors: Richard Seriani, Sr.
 

Welcome to www.piclist.com!

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

  .