FS_CallNamedPipe
FS_CallNamedPipe(
PIOREQ pir
)
The equivalent of CreateFile, perhaps WaitNamedPipe, TransactNamedPipe, and CloseFileData in a single request is performed through FS_CallNamedPipe. This routine handles the Win32 function: CallNamedPipe().
- ir_ppath
- Supplies a pointer to the canonicalized pipe name in unicode.
- ir_rh
- Supplies handle to local NP FS or network resource that contains the named pipe.
- ir_data2
- Supplies a pointer to the output data buffer to write to the pipe.
- ir_size
- Supplies the size in bytes of the output buffer.
- ir_data
- Supplies a pointer to the input buffer that receives data from the pipe.
- ir_length
- Supplies the size in bytes of the input buffer.
- ir_options
- Supplies the priority of the caller.
- ir_timeout
- Supplies the number of milliseconds to wait for the named pipe to be available. Besides numeric values, the following special values may be returned.
TimeOut Special Values: |
|
Value |
Meaning |
NMPWAIT_NO_WAIT |
Do not wait for the named pipe. If the named pipe is not available an error is returned. |
NMPWAIT_WAIT_FOREVER |
No timeout. |
NMPWAIT_USE_DEFAULT_WAIT |
Use default timeout set in call to FS_CreateNamedPipe. |
ir_error |
Returns status of the operation ( 0 if no error, errorcode otherwise ). |
ir_length |
Returns number of bytes actually read from the pipe. |