Microsoft Windows CE 3.0  

AbortPipeTransfers

Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.

This function aborts all transfers on an open USB pipe.

BOOL AbortPipeTransfers(
USB_PIPE
hPipe, 
DWORD
dwFlags
);

Parameters

hPipe
[IN] Handle to an open USB pipe.
dwFlags
[IN] Can contain either of the values USB_NO_WAIT or 0.

Return Values

TRUE indicates success. FALSE indicates failure.

Remarks

This function blocks until all transfers have been successfully canceled on the endpoint unless USB_NO_WAIT is specified. If USB_NO_WAIT is specified, the transfers are flagged to be canceled, and this function returns immediately. Calling this function does not guarantee that no more transfers will be completed; any outstanding transfers will complete even after this function is called. Any registered completion callbacks will be invoked.

Requirements

Runs on Versions Defined in Include Link to
Windows CE OS 2.10 and later      
Note   This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.


 Last updated on Tuesday, July 13, 2004

© 2004 Microsoft Corporation. All rights reserved.