Export (0) Print
Expand All
Expand Minimize

WinUsb_AbortPipe function

The WinUsb_AbortPipe function aborts all of the pending transfers for a pipe. This is a synchronous operation.

Syntax


BOOL __stdcall WinUsb_AbortPipe(
  _In_  WINUSB_INTERFACE_HANDLE InterfaceHandle,
  _In_  UCHAR PipeID
);

Parameters

InterfaceHandle [in]

An opaque handle to an interface that contains the endpoint with which the pipe is associated.

To abort transfers on the pipe associated with the endpoint in the first interface, use the handle returned by WinUsb_Initialize. For all other interfaces, use the handle to the target interface, retrieved by WinUsb_GetAssociatedInterface.

PipeID [in]

The identifier (ID) of the control pipe. The PipeID parameter is an 8-bit value that consists of a 7-bit address and a direction bit. This parameter corresponds to the bEndpointAddress field in the endpoint descriptor.

Return value

WinUsb_AbortPipe returns TRUE if the operation succeeds. Otherwise, this routine returns FALSE, and the caller can retrieve the logged error by calling GetLastError.

GetLastError can return the following error code.

Return codeDescription
ERROR_INVALID_HANDLE

The caller passed NULL in the InterfaceHandle parameter.

 

Requirements

Header

Winusb.h (include Winusb.h)

Library

Winusb.lib

See also

WinUSB
WinUsb_Initialize
WinUsb_Free
WinUSB Functions

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft