ListManager.Rename Method (PIA)

Use this method to rename a list.

Definition

[Visual Basic .NET]

Imports Microsoft.CommerceServer.Interop.Targeting
…
Public Sub Rename(listID As Object,
 newListName As String)

[C#]

using Microsoft.CommerceServer.Interop.Targeting;
…
public void Rename(objectlistID,
 stringnewListName);

Parameters

[Visual Basic .NET]

  • listID
    An Object that specifies the ID or name of the list to be renamed.
  • newListName
    A String that contains the new name for the list.

[C#]

  • listID
    An object that specifies the ID or name of the list to be renamed.
  • newListName
    A string that contains the new name for the list.

Exceptions

This method may throw one of many mapped exceptions or an exception of type COMException. See Standard COM Errors for additional details.

[Visual Basic .NET]

The following table shows the custom COM errors that a COMException can wrap.

Value Description
&H8C400007 The specified list has already been created
&H8C400008 The specified list is currently busy with another operation.
&H8C40001D The specified list is in a FAILED state and may not be used for the operation.
&H8C400006 The specified list does not exist.
&H8C400003 Error while executing SQL/ADO operation.
&H80040007 The ListManager object has not been properly initialized.

[C#]

The following table shows the custom COM errors that a COMException can wrap.

Value Description
0x8C400007 The specified list has already been created
0x8C400008 The specified list is currently busy with another operation.
0x8C40001D The specified list is in a FAILED state and may not be used for the operation.
0x8C400006 The specified list does not exist.
0x8C400003 Error while executing SQL/ADO operation.
0x80040007 The ListManager object has not been properly initialized.

Remarks

The new name must not be the same as any existing list name.

[Visual Basic .NET]

Example

oListManager.Rename ("{454799A2-312B-4F5F-90A0-F514FBA0EC5A}", "Tequila")

Requirements

Namespace: Microsoft.CommerceServer.Interop.Targeting

Platforms: Windows 2000, Windows Server 2003

Assembly: listmanagerlib (in listmanagerlib.dll)

See Also

ListManager Class

Copyright © 2005 Microsoft Corporation.
All rights reserved.