ICatalogManager::RemovePropertyValue
Use this method to remove a defined value from an enumeration property.
Definition
HRESULT ICatalogManager::RemovePropertyValue(BSTRstrPropertyName,BSTRstrLegalValue);
Parameters
strPropertyName
[in] A BSTR that contains the name of the enumeration property from which the specified value will be removed.
strLegalValue
[in] A BSTR that contains the defined value to be removed as a choice from the specified enumeration 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 property did not exist. |
E_CAT_PROP_NOT_ENUM | 0x88980007 | The specified property was not of type cscEnumeration. Call this method only for enumeration type properties. |
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.
Caution
- When a value is removed from an enumeration type property all products that have that property set to that value will have the value changed to NULL.
See Also
ICatalogManager::AddPropertyValue