Share via


ICatalogManager::RenameProperty

Ee825083.c++_off(en-US,CS.10).gifEe825083.vb_on(en-US,CS.10).gif

Use this method to rename a property.

Definition

HRESULT ICatalogManager::RenameProperty(BSTRstrOldPropertyName,BSTRstrNewPropertyName);

Parameters

strOldPropertyName

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

strNewPropertyName

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

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_PROP_DOESNT_EXIST 0x88980005 The specified old property name did not exist.
E_CAT_PROP_EXISTS 0x88980003 A property with the specified new property name already existed.
E_CAT_PROP_IS_ID 0x88980011 The property name you specified was used as a ProductID or VariantID of a catalog. These properties are specified when a catalog is created and cannot be renamed or deleted.

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

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

See Also

CatalogManager Object

ICatalogManager::RenameDefinition


All rights reserved.