IVssAsync::Cancel method

The Cancel method cancels an incomplete asynchronous operation.

Syntax

HRESULT Cancel(

);

Parameters

This method has no parameters.

Return Value

All calls to Cancel for all IVssAsync objects support the following status codes.

Value Meaning
S_OK
The asynchronous operation had been successfully canceled.
VSS_S_ASYNC_CANCELLED
The asynchronous operation had been canceled prior to calling this method.
VSS_S_ASYNC_FINISHED
The asynchronous operation had completed prior to calling this method.
VSS_E_UNEXPECTED
Unexpected error. The error code is logged in the error log file. For more information, see Event and Error Handling Under VSS.

Windows Server 2008, Windows Vista, Windows Server 2003 and Windows XP:  This value is not supported until Windows Server 2008 R2 and Windows 7. E_UNEXPECTED is used instead.

 

If an operation has completed unsuccessfully before Cancel was called, then Cancel returns the error that operation encountered.

To obtain a complete list of return values for a specific IVssAsync::Cancel, see the error codes of the method that returned the IVssAsync object.

Requirements

   
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header vss.h
Library VssApi.lib

See Also

IVssAsync

IVssAsync::QueryStatus