CatalogManager3.AddDefinitionProperty Method (PIA)

  • Article

Use this method to add an existing property to an existing category or product definition.

Definition

[Visual Basic .NET]

Imports Microsoft.CommerceServer.Interop.Catalog
…
Public Sub AddDefinitionProperty(strDefinitionName As String,
  strPropertyName As String)

[C#]

using Microsoft.CommerceServer.Interop.Catalog;
…
public void AddDefinitionProperty(stringstrDefinitionName,
  stringstrPropertyName);

Parameters

[Visual Basic .NET]

  • strDefinitionName
    A String that contains the name of the definition to which the property will be added.
  • strPropertyName
    A String that contains the name of the property.

[C#]

  • strDefinitionName
    A string that contains the name of the definition to which the property will be added.
  • strPropertyName
    A string that contains the name of the property.

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.

Name Value Description
E_CAT_CATMGR_NOT_INITIALIZED

[C#] 0x889800B

[Visual Basic .NET] &H8898005

 The CatalogManager object has not been initialized. The CatalogManager object should be initialized before calling this method.
E_CAT_INVALID_DEFINITION_LENGTH

[C#] 0x889800E

[Visual Basic .NET] &H889800A

 The definition name that you specified is invalid. Definition names should be between 1 and 128 characters in length.
E_CAT_INVALID_PROPERTY_NAME

[C#] 0x889800A

[Visual Basic .NET] &H8898002

 The property name you specified is invalid. Property Names cannot be blank and cannot exceed 100 characters. Property names cannot begin with a digit and cannot contain one of the following five reserved characters .,"[]
E_CAT_DEFINITION_DOESNT_EXIST

[C#] 0x8898000

[Visual Basic .NET] &H889800B

 The definition you specified does not exist.
E_CAT_PROP_DOESNT_EXIST

[C#] 0x8898000

[Visual Basic .NET] &H8898005

 The property name you specified does not exist.
E_CAT_PROP_IN_DEFINITION

[C#] 0x8898000

[Visual Basic .NET] &H889800D

 The property you specified is already part of that definition.
E_CAT_ERROR_VARIANT_PROP

[C#] 0x889800A

[Visual Basic .NET] &H8898003

 A variant property cannot be added to a Category definition.

Remarks

This method adds a property to a definition. Any products or categories created from the definition will also have the property. A property can only be added to a definition once. A property cannot be used in a product definition as both a property and a variant property.

[Visual Basic .NET]

Example

myCatalogManager.AddDefinitionProperty("Printers", "Manufacturer")

Requirements

Namespace: Microsoft.CommerceServer.Interop.Catalog

Platforms: Windows 2000, Windows Server 2003

Assembly: cataloglib (in cataloglib.dll)

See Also

CatalogManager3 Class

CatalogManager3.AddDefinitionVariantProperty

CatalogManager3.RemoveDefinitionProperty

Copyright © 2005 Microsoft Corporation.
All rights reserved.