IListManager::CancelOperation

Ee825904.c++_off(en-US,CS.10).gifEe825904.vb_on(en-US,CS.10).gif

Use this method to cancel the specified ListManager operation.

Definition

HRESULT IListManager::CancelOperation(VARIANTvarOpID);

Parameters

varOpID

[in] A VARIANT that specifies the Operation ID of the operation to be cancelled.

Return Values

This method returns an HRESULT indicating whether it completed successfully. See the Error Values section for more details.

Error Values

This method returns S_OK (0x00000000) to indicate success and either standard or custom COM HRESULT error values to indicate failure. For more information about standard COM errors, see Standard COM Errors.

The following table shows the custom COM errors, and the standard COM errors with special meanings, that this method can return.

Constant Value Description
E_LM_OPERATION_NOT_FOUND 0x8C400004 The operation ID does not represent a currently running operation.
E_LM_SQLERROR 0x8C400003 Error while executing SQL/ADO operation.
OLE_E_BLANK 0x80040007 The ListManager object has not been properly initialized.

Additional information may be available using the global Err object, which can be accessed using the API function GetErrorInfo. In particular, the GetDescription method of the IErrorInfo interface may return a text description of the error.

Remarks

The Operation ID passed to this method in the varOpID parameter can be obtained from any of the following calls when they are executed asynchronously:

In addition, the Operation IDs of all currently active operations can be retrieved using the GetOperations method.

For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.

See Also

ListManager Object


All rights reserved.