IWDFUsbTargetPipe::Flush method (wudfusb.h)

[Warning: UMDF 2 is the latest version of UMDF and supersedes UMDF 1. All new UMDF drivers should be written using UMDF 2. No new features are being added to UMDF 1 and there is limited support for UMDF 1 on newer versions of Windows 10. Universal Windows drivers must use UMDF 2. For more info, see Getting Started with UMDF.]

The Flush method discards any data that WinUsb saved when the device returned more data than the client requested.

Syntax

HRESULT Flush();

Return value

Flush returns one of the following values:

Return code	Description
S_OK	Flush successfully discarded any extra data that WinUsb saved.
E_OUTOFMEMORY	Flush encountered an allocation failure.
An error code that is defined in Winerror.h	This value corresponds to the error code that the WinUsb API returned.

Remarks

The Flush method generates a UMDF request and synchronously sends the request to the I/O target.

For more information about how Flush works, see the WinUsb_FlushPipe function.

Requirements

Requirement	Value
End of support	Unavailable in UMDF 2.0 and later.
Target Platform	Desktop
Minimum UMDF version	1.5
Header	wudfusb.h (include Wudfusb.h)
DLL	WUDFx.dll

See also

IWDFUsbTargetPipe

WinUsb_FlushPipe