Product3.SetRelatedProducts Method (PIA)

Article
11/12/2009

Use this method to update product relationships.

Definition

[Visual Basic .NET]

Imports Microsoft.CommerceServer.Interop.Catalog
Imports ADODB26Lib     ' for _Recordset
…
Sub SetRelatedProducts(pRSRelatedCategories As _Recordset)

[C#]

using Microsoft.CommerceServer.Interop.Catalog;
using ADODB26Lib;                              //For _Recordset
…
public void SetRelatedProducts(_RecordsetpRSRelatedCategories);

Parameters

[Visual Basic .NET]

pRSRelatedCategories
A Recordset object that contains the related products.

[C#]

pRSRelatedCategories
A Recordset object that contains the related products.

Return Values

None.

Exceptions

This method may throw one of many mapped exceptions or an exception of type COMException. See Standard COM Errors for additional details.

The following table shows the custom COM errors that a COMException can wrap.

Constant	Value	Description
E_POINTER	[C#] 0x80004003 [Visual Basic .NET] &H80004003	Invalid pointer
E_CAT_PRODUCT_DOESNT_EXIST	[C#] 0x8898001E [Visual Basic .NET] &H8898001E	The product you specified does not exist.
E_CAT_DEFN_NO_RELATIONSHIP_EXISTS	[C#] 0x88980045 [Visual Basic .NET] &H88980045	The relationship that you specified either does not exist or is an inherited relationship, and therefore cannot be edited.
E_CAT_VC_ERROR_IN_PROPAGATING_BC_CHANGES	[C#] 0x88980101 [Visual Basic .NET] &H88980101	There was an error in propagating the base catalog changes to the dependent virtual catalogs.

Error Values

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 by using the global Err object. In particular, the Description property may contain a text description of the error.

Remarks

The recordset used for the pRSRelatedCategories parameter should be obtained from the get_RelatedProducts method.

This method will update the value of the RelationshipDescription field for the current language of the catalog.

When calling this method on an inherited product in a virtual catalog, the method will have no effect if the relationship is inherited from a base catalog. If the relationship was added in the virtual catalog, changes will be updated. 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.

The input recordset should not contain any rows that are inherited relationships. Such rows must be removed from the recordset first if they exist, because they may be returned by the RelatedProducts method.

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

Requirements

Namespace: Microsoft.CommerceServer.Interop.Catalog

Platforms: Windows 2000, Windows Server 2003

Assembly: Cataloglib (in Cataloglib.dll)

Share via