FS_SetNamedPipeHandleState


FS_SetNamedPipeHandleState(
 PIOREQ pir
 )

Information about a given named pipe handle is set through FS_SetNamedPipeHandleState. This routine handles the Win32 function: SetNamedPipeHandleState().

ir_rh

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

ir_fh

Supplies FSD file handle of an opened named pipe.

ir_sfn

Supplies system file number.

ir_options

Supplies pipe mode state.

Pipe Mode State Values:

Any combination of the following options may be specified.

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_length

Supplies the length of the handle data structure.

ir_data

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

Handle Data Structure:

Value

Meaning

hd_size

Supplies the maximum number of bytes that will be collected on the client machine before transfering to the server. This value will be set to NULL if the handle is for the server end of a named pipe or when the client and server applications are on the same machine.

hd_timeout

Supplies 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.


ir_error

Returns status of the operation ( 0 if no error, errorcode otherwise ).