Share via


IListManager::Rename

Ee799427.c++_off(en-US,CS.10).gifEe799427.vb_on(en-US,CS.10).gif

Use this method to rename a list.

Definition

HRESULT IListManager::Rename(VARIANTlistID,BSTRnewListName);

Parameters

listID

[in] A VARIANT that specifies the ID or name of the list to be renamed.

newListName

[in] A BSTR that contains the new name for the list.

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 that this method can return.

Constant Value Description
E_LM_LIST_ALREADY_EXISTS 0x8C400007 The specified list has already been created
E_LM_LIST_BUSY 0x8C400008 The specified list is currently busy with another operation.
E_LM_LIST_IN_FAILED_STATE 0x8C40001D The specified list is in a FAILED state and may not be used for the operation.
E_LM_LIST_NOT_FOUND 0x8C400006 The specified list does not exist.
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 new name must not be the same as any existing list name.

See Also

ListManager Object


All rights reserved.