2.3.49 FSCTL_PIPE_WAIT Request

The FSCTL_PIPE_WAIT Request requests that the server wait until either a time-out interval elapses, or an instance of the specified named pipe is available for connection.


0


1


2


3


4


5


6


7


8


9

1
0


1


2


3


4


5


6


7


8


9

2
0


1


2


3


4


5


6


7


8


9

3
0


1

Timeout

...

NameLength

TimeoutSpecified

Padding

Name (variable)

...

Timeout (8 bytes): A 64-bit signed integer that specifies the maximum amount of time, in units of 100 milliseconds, that the function can wait for an instance of the named pipe to be available.

NameLength (4 bytes): A 32-bit unsigned integer that specifies the size, in bytes, of the named pipe Name field.

TimeoutSpecified (1 byte): A Boolean (section 2.1.8) value that specifies whether or not the Timeout parameter will be ignored.

Value

Meaning

FALSE

Indicates that the server MUST wait forever (no timeout) for the named pipe. Any value in Timeout MUST be ignored.

TRUE

Indicates that the server MUST use the value in the Timeout parameter.

Padding (1 byte): The client SHOULD set this field to 0x00, and the server MUST ignore it.

Name (variable): A Unicode string that contains the name of the named pipe. Name MUST not include the "\pipe\", so if the operation was on \\server\pipe\pipename, the name would be "pipename".

For more information on named pipes, see [PIPE].