CatalogManager3.RemoveDefinitionProperty Method (PIA)

Use this method to remove the specified property or variant property from the specified definition.

Definition

[Visual Basic .NET]

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

[C#]

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

Parameters

[Visual Basic .NET]

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

[C#]

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

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_NOT_IN_DEFINITION

[C#] 0x8898000

[Visual Basic .NET] &H889800E

The property you specified is not part of that definition.

Remarks

When you remove a property from a definition, it is also removed from any products, product variants, or categories created from that definition.

Ee798201.caution(en-US,CS.20).gif Caution

  • Use caution when using this method. In most cases, calling this method results in the deletion of data.
  • Removing the last variant property in a product family definition will convert it to a product definition and will remove all existing product variants based on this definition.

[Visual Basic .NET]

Example

myCatalogManager.RemoveDefinitionProperty("T-Shirts", "Color")

Requirements

Namespace: Microsoft.CommerceServer.Interop.Catalog

Platforms: Windows 2000, Windows Server 2003

Assembly: cataloglib (in cataloglib.dll)

See Also

CatalogManager3 Class

CatalogManager3.AddDefinitionProperty

CatalogManager3.AddDefinitionVariantProperty

CatalogManager3.GetDefinitionProperties

Copyright © 2005 Microsoft Corporation.
All rights reserved.