ICatalogManager3::RenameDefinition Method [C++]

Article
11/12/2009

Use this method to rename a definition.

Definition

[C++]

HRESULT ICatalogManager3::RenameDefinition(BSTRstrOldName,
  BSTRstrNewName);

[Visual Basic]

Sub RenameDefinition(strOldName As String,
  strNewName As String)

Parameters

strOldName[C++]
[in] A BSTR that contains the existing name of the definition.
strOldName[Visual Basic]
A String that contains the existing name of the definition.
strNewName[C++]
[in] A BSTR that contains the new name for the definition.
strNewName[Visual Basic]
A String that contains the new name for the definition.

Return Values

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

[Visual Basic] None.

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.

Name	Value	Description
E_CAT_CATMGR_NOT_INITIALIZED	[C++] 0x889800B [Visual Basic] &H8898005	The CatalogManager object has not been initialized. The CatalogManager object should be initialized before calling this method.
E_CAT_INVALID_DEFINITION_LENGTH	[C++] 0x889800E [Visual Basic] &H889800A	The definition name that you specified is invalid. Definition names should be between 1 and 128 characters in length.
E_CAT_DEFINITION_EXISTS	[C++] 0x8898000 [Visual Basic] &H889800A	The Definition you specified already exists.
E_CAT_DEFINITION_DOESNT_EXIST	[C++] 0x8898000 [Visual Basic] &H889800B	The Definition you specified does not exist.

[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

This method affects every product and category using the definition.

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