FS_GetNamedPipeHandleState

FS_GetNamedPipeHandleState(
 PIOREQ pir
 )
 

Information about a given named pipe handle is obtained through FS_GetNamedPipeHandleState. This routine handles the Win32 function: GetNamedPipeHandleState().

ir_rh

Supplies handle to local NP FS or network resource that contains the named pipe.

ir_fh

Supplies FSD file handle of an opened named pipe.

ir_sfn

Supplies system file number.

ir_data

Supplies an optional pointer to a handle data structure where additional handle information is placed.

Handle Data Structure:
Value	Meaning
hd_curinst	Return value, look below.
hd_size	Return value, look below.
hd_wtimeout	Return value, look below.
hd_length	Supplies the length of the username buffer.
hd_name	Supplies an optional pointer to a buffer where the username of the client application is returned. This parameter is only valid on a handle to the server end of a named pipe, it is invalid on a handle to the client end of a named pipe.

ir_length

Supplies the length of the handle data structure.

ir_error	Returns status of the operation ( 0 if no error, errorcode otherwise ).
ir_options	Returns pipe mode state.

Pipe Mode State Values: Any combination of the following mode states may be returned.
Value	Meaning
PIPE_NOWAIT	Nonblocking mode is to be used for this handle. If not specified blocking mode will be used.
PIPE_READMODE_MESSAGE	Read pipe as a message stream. If not specified the pipe will be read as a byte stream.

ir_data

Returns a filled in handle data structure where additional handle information is placed.

Handle Data Structure:
Value	Meaning
hd_curinst	Returns the number of current pipe instances.
hd_size	Returns the maximum number of bytes that will be collected on the client machine before transferring to the server. The returned value is ignored on a handle to the server end of a named pipe or when the client and server applications are on the same machine.
hd_wtimeout	Returns the collection timeout value (in milliseconds). The collection timeout is the maximum time that can pass before a remote named pipe transfers buffered information over the network. This value will be NULL if the handle is for the server end of a named pipe or when client and server applications are on the same machine.
hd_length	Supplied value, contains the length of the username buffer.
hd_name	Returns the buffer filled in with the username of the client application if this is a handle to the server end of a named pipe.