Share via

Category3.SetCategoryProperties Method

  • Article
  • 11/12/2009

Use this method to set values for the properties of this category.

Definition

[Visual Basic .NET]

Imports Microsoft.CommerceServer.Interop.Catalog
Imports ADODBLib26     ‘ for _Recordset
…
Public Sub SetCategoryProperties(pRSCategory As _Recordset,
  Optional fForceUpdate As Object)

[C#]

using Microsoft.CommerceServer.Interop.Catalog;
using ADODB26Lib;                              //For _Recordset
…
public void SetCategoryProperties(_RecordsetpRSCategory,
  objectfForceUpdate);

Parameters

[Visual Basic .NET]

  • pRSCategory
    The _Recordset interface of a Recordset object that contains the properties for this category.
  • fForceUpdate
    An Object that causes a forced update of the category properties.

[C#]

  • pRSCategory
    A _Recordset interface to a Recordset object that contains the properties for this category.
  • fForceUpdate
    An object that causes a forced update of the category properties. Set to Type.Missing to enforce the default behavior.

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_CAT_VC_CANT_EDIT_INCLUDED_CATEGORY

[C#] 0x88980105

[Visual Basic .NET] &H88980105

 A virtual catalog's included categories cannot be directly edited. Instead, they can be edited only in the base catalog context.
E_CAT_INVALID_OPERATION_FOR_ROOT_CATEGORY

[C#] 0x889800F8

[Visual Basic .NET] &Hx889800F8

 This API cannot be called for a root category.
E_CAT_INVALID_PARAMETER

[C#] 0x889800B6

[Visual Basic .NET] &H889800B6

 The input parameter <parameter number> is invalid.
E_CAT_CATEGORY_DOESNT_EXIST

[C#] 0x8898001C

[Visual Basic .NET] &H8898001C

 The category you specified doesn't exist.
E_CAT_CATEGORY_CHANGED

[C#] 0x88980028

[Visual Basic .NET] &H88980028

 The category has been changed since it was last read.
E_CAT_INVALID_PROPERTY_VALUE

[C#] 0x889800B4

[Visual Basic .NET] &H889800B4

 The value <value> specified for the property <property name>does not satisfy the Minimum or Maximum constraints defined for the property. For string properties, the specified value should be between the minimum and maximum lengths defined for the property. For numeric properties, the specified value should be between minium and maximum values. For enumeration properties, the specified value should be one of the valid values defined for the property.
E_CAT_NULL_PRICE_NOT_ALLOWED [C#] 0x8898003F

[Visual Basic .NET] &H8898003F

 The list price for this category cannot be blank as this category is being used as a pricing category by other products in the catalog.

Remarks

Use the SetCategoryProperties method to modify the properties of a category. The pRSCategory parameter specifies a _Recordset interface to a Recordset object that describes the new property values for this category. Use the _Recordset interface to a Recordset object returned by the GetCategoryProperties method so that its timestamp can be compared for error checking.

If the fForceUpdate parameter is set to false, and the property values in the*****pRSCategory* parameter have changed, the method will fail.

This method will not update the built-in fields in the catalog. If this category is being used as a pricing category, then this method will update the price of all the products using this category as the pricing category.

The category name returned in this recordset will not contain the appended catalog name.

[Visual Basic .NET]

Example

myCategory.SetCategoryProperties(pRSCategory, "True")

Requirements

Namespace: Microsoft.CommerceServer.Interop.Catalog

Platforms: Windows 2000, Windows Server 2003

Assembly: cataloglib (in cataloglib.dll)

See Also

Category Class

Copyright © 2005 Microsoft Corporation.
All rights reserved.