IListManager::CancelOperation Method [C++]

  • Article

Use this method to cancel the specified ListManager operation.

Definition

[C++]

HRESULT IListManager::CancelOperation(VARIANTvarOpID);

[Visual Basic]

Sub CancelOperation(varOpID As Variant)

Parameters

  • varOpID[C++]
    [in] A VARIANT that specifies the Operation ID of the operation to be cancelled.
  • varOpID[Visual Basic]
    A Variant that specifies the Operation ID of the operation to be cancelled.

[C++]

Return Values

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

Error Values

[C++] 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.

[Visual Basic] This method sets the Number property of the global Err object to S_OK (&H00000000) to indicate success and to either standard or custom COM 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 [C++] 0x8C400004

[Visual Basic] &H8C400004

 The operation ID does not represent a currently running operation.
E_LM_SQLERROR [C++] 0x8C400003

[Visual Basic] &H8C400003

 Error while executing SQL/ADO operation.
OLE_E_BLANK [C++] 0x80040007

[Visual Basic] &H80040007

 The ListManager object has not been properly initialized.

[C++] 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.

[Visual Basic] Additional information may be available using the global Err object. In particular, the Description property may contain 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:

[C++]

[Visual Basic]

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

[Visual Basic] In addition, the Operation IDs of all known 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

[C++]ListManager Object

[Visual Basic]ListManager Object

Copyright © 2005 Microsoft Corporation.
All rights reserved.