FS_GetNamedPipeInfo( PIOREQ pir )
Information about a given named pipe is obtained through FS_GetNamedPipeInfo. This routine handles the Win32 function: GetNamedPipeInfo().
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 the information level requested.
ir_length
Supplies the length of the pipe info structure.
ir_data
Supplies an optional pointer to a pipe info structure where the named pipe information is placed.
Pipe Info Structure: | |
Value | Meaning |
pi_type | Return value, look below. |
pi_outsize | Return value, look below. |
pi_insize | Return value, look below. |
pi_maxinst | Return value, look below. |
pi_curinst | Return value, look below. |
pi_length | Supplies the length of the username buffer. |
pi_name | Supplies an optional pointer to a buffer where the pipe name is returned. |
ir_error | Returns status of the operation ( 0 if no error, errorcode otherwise ). |
ir_data | Supplies an optional pointer to a pipe info structure where the named pipe information is placed. |
Pipe Info Structure: | |
Value | Meaning |
pi_type | Returns the type of named pipe. |
Named Pipe Type Values: Any combination of the following flags may be returned. | |
Value | Meaning |
PIPE_END_SERVER | The handle is the server end of a named pipe. |
PIPE_TYPE_MESSAGE | The pipe is a message stream pipe. If not specified the pipe is a byte stream pipe. |
pi_outsize | Returns the size in bytes of the outgoing data buffer. A return value of zero indicates the buffer is allocated as needed. |
pi_insize | Returns the size in bytes of the incoming data buffer. A return value of zero indicates the buffer is allocated as needed. |
pi_maxinst | Returns the maximum number of pipe instances that can be created. Besides numeric values, the following special value may be returned. |
Max Instances Special Values: | |
Value | Meaning |
PIPE_UNLIMITED_INSTANCES | This is an indicator that the maximum number is requested. The value of the equate may be higher or lower than the implementation limit, which may vary over time. |
pi_curinst | Returns the current number of pipe instances that can be created. Besides numeric values, the following special value may be returned. |
pi_length | Supplied value, contains the length of the username buffer. |
pi_name | Returns the username buffer filled in with the pipe name. |