WinUsb_FlushPipe function
The WinUsb_FlushPipe function discards any data that is cached in a pipe. This is a synchronous operation.
Syntax
BOOL __stdcall WinUsb_FlushPipe( _In_ WINUSB_INTERFACE_HANDLE InterfaceHandle, _In_ UCHAR PipeID );
Parameters
- InterfaceHandle [in]
-
An opaque handle to the interface with which the specified pipe's endpoint is associated. To clear data in a pipe that is associated with the endpoint on the first (default) 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_FlushPipe 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 code | Description |
|---|---|
|
The caller passed NULL in the InterfaceHandle parameter. |
Requirements
|
Header |
|
|---|---|
|
Library |
|
See also
Send comments about this topic to Microsoft
Build date: 12/5/2013
