IProduct3::RemoveRelationshipToCategory Method [C++]
Use this method to remove the specified relationship between the specified category and this product.
Definition
[C++]
HRESULT IProduct3::RemoveRelationshipToCategory(BSTRstrRelatedCategoryName,
BSTRstrRelationshipNameBSTRstrCatalogName);
[Visual Basic]
Sub RemoveRelationshipToCategory(strRelatedCategoryName As String,
strRelationshipName As StringOptional strCatalogName As Variant)
Parameters
strRelatedCategoryName[C++]
[in] A BSTR that contains the name of the category that is to have its relationship to this product removed.
strRelatedCategoryName[Visual Basic]
A String that contains the name of the category that is to have its relationship to this product removed.
strRelationshipName[C++]
[in] A BSTR that contains the name of the relationship to be removed.
strRelationshipName[Visual Basic]
A String that contains the name of the relationship to be removed.
strCatalogName[C++]
[in, optional] A BSTR that contains the name of the catalog containing the name of the category that is to have its relationship to this product removed.
strCatalogName[Visual Basic]
A String that contains the name of the catalog containing the name of the category that is to have its relationship to this product removed.
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 standard COM HRESULT error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. 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] This method sets the Number property of the global Err object to S_OK (&H00000000) to indicate success and to standard COM error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. Additional information may be available using the global Err object. In particular, the Description property may contain a text description of the error.
The following table describes the custom COM errors this method can return.
| Constant | Value | Description |
|---|---|---|
| E_CAT_CATALOG_DOESNT_EXIST | [C++] 0x88980002 [Visual Basic] &H88980002 |
The catalog name you specified does not exist. |
| E_CAT_INVALID_CATALOGNAME | [C++] 0x88980063 [Visual Basic] &H88980063 |
The catalog name you specified is invalid. Catalog names cannot be blank. |
| E_CAT_INVALID_CATALOG_NAME_LENGTH | [C++] 0x88980042 [Visual Basic] &H88980042 |
The catalog name you specified exceeds the maximum limit of 85 characters. |
| E_CAT_CHARACTER_NOT_ALLOWED | [C++] 0x8898003D [Visual Basic] &H8898003D |
The catalog name you specified has one of the nine reserved characters " [ ] , ' ( )# . which should not be used. |
| E_CAT_INVALID_CATEG_LENGTH | [C++] 0x88980047 [Visual Basic] &H88980047 |
The category name you specified is either blank or exceeds the maximum allowed length of 128 characters or cannot be converted to a string. |
| E_CAT_INVALID_CATEG_LENGTH | [C++] 0x88980047 [Visual Basic] &H88980047 |
The category name you specified is either blank or exceeds the maximum allowed length of 128 characters or cannot be converted to a string. |
| E_CAT_VC_INVALID_PROD_ID_OR_CATEGORY_NAME | [C++] 0x889800FB [Visual Basic] &H889800FB |
The value you specified for the productID or CategoryName exceeds the maximum allowed length of 348 characters. |
| E_CAT_INVALID_RELATION_NAME | [C++] 0x88980054 [Visual Basic] &H88980054 |
The value you specified for the Relationship name is blank or exceeds 128 characters. Relationship names should not be blank and should be less than or equal to 128 characters. |
| E_CAT_INVALID_PARAMETER | [C++] 0x889800B6 [Visual Basic] &H889800B6 |
The input parameter <parameter number> is invalid. |
| E_CAT_PRODUCT_DOESNT_EXIST | [C++] 0x8898001E [Visual Basic] &H8898001E |
The product you specified doesn't exist. |
| E_CAT_CATEGORY_DOESNT_EXIST | [C++] 0x8898001C [Visual Basic] &H8898001C |
The category you specified doesn't exist. |
| E_CAT_DEFN_NO_RELATIONSHIP_EXISTS | [C++] 0x88980045 [Visual Basic] &H88980045 |
The relationship that you specified either does not exist or is a inherited relationship, and therefore cannot be edited. |
| E_CAT_VC_ERROR_IN_PROPAGATING_BC_CHANGES | [C++] 0x88980101 [Visual Basic] &H88980101 |
There was an error in propagating the base catalog changes to the dependent virtual catalogs. |
Remarks
When calling this method on an inherited category in a virtual catalog, if the relationship is inherited from a base catalog, the method will return an error: "The relationship that you specified either does not exist or is an inherited relationship, and therefore cannot be edited." If the relationship was added in the virtual catalog, it will be removed. Inherited hierarchy and relationship links cannot be removed or changed in inherited categories. To modify inherited relationships use a Category object obtained from the base Catalog object.
For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.
[Visual Basic]
Example
' Remove the "Accessory" relationship this product has to
' the "Apparel" category.
myProduct.RemoveRelationshipToCategory "Apparel", "Accessory", "myCat"
See Also
[C++]Product Object
[Visual Basic]Product Object
[C++]IProduct3::get_RelatedCategories
[Visual Basic]Product.RelatedCategories
[C++]IProduct3::AddRelationshipToCategory
[Visual Basic]Product.AddRelationshipToCategory
[C++]IProduct3::RemoveRelationshipToProduct
[Visual Basic]Product.RemoveRelationshipToProduct
Copyright © 2005 Microsoft Corporation.
All rights reserved.