Skip to content

Latest commit

 

History

History
104 lines (78 loc) · 2.9 KB

nf-winusb-winusb_resetpipe.md

File metadata and controls

104 lines (78 loc) · 2.9 KB
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date 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 req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:winusb.WinUsb_ResetPipe
WinUsb_ResetPipe function (winusb.h)
The WinUsb_ResetPipe function resets the data toggle and clears the stall condition on a pipe.
WinUsb_ResetPipe
WinUsb_ResetPipe function [Buses]
buses.winusb_resetpipe
winusb/WinUsb_ResetPipe
winusbfunc_6d4baf88-4b6f-46fb-802b-67ac51ddaf8d.xml
buses\winusb_resetpipe.htm
buses
0fd30723-8cb9-4e29-942b-abe48c691d8e
12/05/2018
WinUsb_ResetPipe, WinUsb_ResetPipe function [Buses], buses.winusb_resetpipe, winusb/WinUsb_ResetPipe, winusbfunc_6d4baf88-4b6f-46fb-802b-67ac51ddaf8d.xml
winusb.h
Winusb.h
Universal
Winusb.lib
Winusb.dll
Windows
19H1
WinUsb_ResetPipe
winusb/WinUsb_ResetPipe
c++
APIRef
kbSyntax
DllExport
Winusb.dll
WinUsb_ResetPipe

WinUsb_ResetPipe function

-description

The WinUsb_ResetPipe function resets the data toggle and clears the stall condition on a pipe.

-parameters

-param InterfaceHandle [in]

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

To reset a pipe associated with an 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.

-param PipeID [in]

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

-returns

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

GetLastError can return the following error code.

Return code Description
ERROR_INVALID_HANDLE
The caller passed NULL in the InterfaceHandle parameter.

-see-also

WinUSB

WinUSB Functions

WinUsb_Initialize