CatalogManager3.RemovePropertyValue Method (PIA)

  • Article

Use this method to remove a defined value from an enumeration property.

Definition

[Visual Basic .NET]

Imports Microsoft.CommerceServer.Interop.Catalog
…
Public Sub RemovePropertyValue(strPropertyName As String,
  strLegalValue As String,
  Optional strLang As String)

[C#]

using Microsoft.CommerceServer.Interop.Catalog;
…
public void RemovePropertyValue(stringstrPropertyName,
  stringstrLegalValue,
  string strLang);

Parameters

[Visual Basic .NET]

  • strPropertyName
    A String that contains the name of the enumeration property from which the specified value will be removed.
  • strLegalValue
    A String that contains the defined value to be removed from the specified enumeration property.
  • strLang
    A String that contains the ISO 639+1 language identifier.

[C#]

  • strPropertyName
    A string that contains the name of the enumeration property from which the specified value will be removed.
  • strLegalValue
    A string that contains the defined value to be removed from the specified enumeration property.
  • strLang
    A string that contains the ISO 639+1 language identifier.

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_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_INVALID_PARAMETER

[C#] 0x889800B

[Visual Basic .NET] &H8898006

 The input parameter <parameter number> is invalid.
E_CAT_INVALID_ENUMERATED_VALUE

[C#] 0x889800E

[Visual Basic .NET] &H8898009

 The value you specified for the enumerated property exceeds 128 characters
E_CAT_PROP_DOESNT_EXIST

[C#] 0x8898000

[Visual Basic .NET] &H8898005

 The property name you specified does not exist.
E_CAT_PROP_NOT_ENUM

[C#] 0x8898000

[Visual Basic .NET] &H8898007

 The property you specified is not the "cscEnumeration" data-type. This operation can only be performed on these types of Properties.

Remarks

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

  • When a value is removed from an enumeration type property all products that have that property set to that value will have the value changed to null.

[Visual Basic .NET]

Example

myCatalogManager.RemovePropertyValue("Color", "Pink")

Requirements

Namespace: Microsoft.CommerceServer.Interop.Catalog

Platforms: Windows 2000, Windows Server 2003

Assembly: cataloglib (in cataloglib.dll)

See Also

CatalogManager3 Class

CatalogManager3.AddPropertyValue

CatalogManager3.GetPropertyValues

Copyright © 2005 Microsoft Corporation.
All rights reserved.