Skip to content

Latest commit

 

History

History
86 lines (63 loc) · 2.62 KB

ni-usbfnioctl-ioctl_internal_usbfn_get_pipe_state.md

File metadata and controls

86 lines (63 loc) · 2.62 KB
UID title description old-location tech.root ms.date keywords ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames f1_keywords topic_type api_type api_location api_name
NI:usbfnioctl.IOCTL_INTERNAL_USBFN_GET_PIPE_STATE
IOCTL_INTERNAL_USBFN_GET_PIPE_STATE (usbfnioctl.h)
The class driver sends this request to get the stall state of the specified pipe.
buses\ioctl_internal_usbfn_get_pipe_state.htm
usbref
05/07/2018
IOCTL_INTERNAL_USBFN_GET_PIPE_STATE IOCTL
IOCTL_INTERNAL_USBFN_GET_PIPE_STATE, IOCTL_INTERNAL_USBFN_GET_PIPE_STATE control, IOCTL_INTERNAL_USBFN_GET_PIPE_STATE control code [Buses], buses.ioctl_internal_usbfn_get_pipe_state, usbfnioctl/IOCTL_INTERNAL_USBFN_GET_PIPE_STATE
usbfnioctl.h
Windows
Windows
IOCTL_INTERNAL_USBFN_GET_PIPE_STATE
usbfnioctl/IOCTL_INTERNAL_USBFN_GET_PIPE_STATE
APIRef
kbSyntax
HeaderDef
usbfnioctl.h
IOCTL_INTERNAL_USBFN_GET_PIPE_STATE

IOCTL_INTERNAL_USBFN_GET_PIPE_STATE IOCTL

-description

The class driver sends this request to get the stall state of the specified pipe.

-ioctlparameters

-ioctl-major-code

IRP_MJ_INTERNAL_DEVICE_CONTROL

-input-buffer

A pointer to a USBFNPIPEID type that specifies the pipe ID.

-input-buffer-length

The size of a USBFNPIPEID type.

-output-buffer

A pointer to BOOLEAN value that is set by USB Function Class Extension (UFX) to indicate whether or not the specified pipe is stalled. TRUE, indicates the pipe is in stall state; FALSE indicates the pipe is in clear state.

-output-buffer-length

The size of a BOOLEAN.

-in-out-buffer

-inout-buffer-length

-status-block

UFX completes the request with STATUS_SUCCESS.

-remarks

This request must be sent after sending the IOCTL_INTERNAL_USBFN_ACTIVATE_USB_BUS request.

When stalled, the pipe sends STALL transaction packets to the host. See the Universal Serial Bus (USB) specification for more information.

UFX forwards this IOCTL request to the transfer queue created for the endpoint by UfxEndpointCreate.