3.2.4.20.5 Application Requests a Peek at Pipe Data

  • Article

The application provides:

  • A handle to the Open identifying the named pipe on which to issue the operation.

  • The number of bytes to peek at in the pipe buffer.

If the handle is invalid, or if no Open referenced by the handle is found, the client MUST return an implementation-specific error code. If the handle is valid and Open is found, the client MUST proceed as follows.

For the specified Open, the client MUST select a connection as specified in section 3.2.4.1.7. If no connection is available, the client MUST fail the FSCTL operation.

Otherwise, the client initializes an SMB2 IOCTL Request following the syntax specified in section 2.2.31. The SMB2 header MUST be initialized as follows:

  • The Command field is set to SMB2 IOCTL.

  • The MessageId field is set as specified in section 3.2.4.1.3.

  • The SessionId field is set to Open.TreeConnect.Session.SessionId.

  • The TreeId field is set to Open.TreeConnect.TreeConnectId.

The SMB2 IOCTL Request MUST be initialized as specified in section 2.2.31, with the exception of the following values:

  • The CtlCode field is set to FSCTL_PIPE_PEEK.

  • The FileId field is set to Open.FileId.

  • The InputCount field is set to 0.

  • The OutputOffset field SHOULD<164> be set to zero.

  • The MaxInputResponse field is set to 0.

  • The MaxOutputResponse field is set to the number of bytes that the client requires to peek at.

  • SMB2_0_IOCTL_IS_FSCTL is set to TRUE in the Flags field.

The request MUST be sent to the server.