IListManager::Rename Method [C++]
Use this method to rename a list.
Definition
[C++]
HRESULT IListManager::Rename(VARIANTlistID,
BSTRnewListName);
[Visual Basic]
Sub Rename(listID As Variant,
newListName As String)
Parameters
- listID[C++]
[in] A VARIANT that specifies the ID or name of the list to be renamed. - listID[Visual Basic]
A Variant that specifies the ID or name of the list to be renamed. - newListName[C++]
[in] A BSTR that contains the new name for the list. - newListName[Visual Basic]
A String that contains the new name for the list.
[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 that this method can return.
Constant | Value | Description |
---|---|---|
E_LM_LIST_ALREADY_EXISTS | [C++] 0x8C400007
[Visual Basic] &H8C400007 |
The specified list has already been created |
E_LM_LIST_BUSY | [C++] 0x8C400008
[Visual Basic] &H8C400008 |
The specified list is currently busy with another operation. |
E_LM_LIST_IN_FAILED_STATE | [C++] 0x8C40001D
[Visual Basic] &H8C40001D |
The specified list is in a FAILED state and may not be used for the operation. |
E_LM_LIST_NOT_FOUND | [C++] 0x8C400006
[Visual Basic] &H8C400006 |
The specified list does not exist. |
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 new name must not be the same as any existing list name.
[Visual Basic]
Example
oListManager.Rename "{454799A2-312B-4F5F-90A0-F514FBA0EC5A}", "Tequila"
See Also
[C++]ListManager Object
[Visual Basic]ListManager Object
Copyright © 2005 Microsoft Corporation.
All rights reserved.