ICatalogManager::RenameDefinition

Ee825097.c++_off(en-US,CS.10).gifEe825097.vb_on(en-US,CS.10).gif

Use this method to rename a definition.

Definition

HRESULT ICatalogManager::RenameDefinition(BSTRstrOldName,BSTRstrNewName);

Parameters

strOldName

[in] A BSTR that contains the existing name of the definition.

strNewName

[in] A BSTR that contains the wanted name of the definition.

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_CAT_DEFINITION_DOESNT_EXIST 0x8898000B The specified old definition name did not exist.
E_CAT_DEFINITION_EXISTS 0x8898000A A definition with the specified new name already existed.

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

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.

See Also

CatalogManager Object

ICatalogManager::RenameProperty


All rights reserved.