RemoveEnumerationPropertyValue Method (String, String)

Removes the enumeration value specified by enumValue and language from the current enumerated property.

Namespace:  Microsoft.CommerceServer.Catalog
Assembly:  Microsoft.CommerceServer.Catalog (in Microsoft.CommerceServer.Catalog.dll)

Syntax

'Declaration
Public Sub RemoveEnumerationPropertyValue ( _
    enumValue As String, _
    language As String _
)
'Usage
Dim instance As CatalogEnumerationProperty
Dim enumValue As String
Dim language As String

instance.RemoveEnumerationPropertyValue(enumValue, _
    language)
public void RemoveEnumerationPropertyValue(
    string enumValue,
    string language
)
public:
void RemoveEnumerationPropertyValue(
    String^ enumValue, 
    String^ language
)
public function RemoveEnumerationPropertyValue(
    enumValue : String, 
    language : String
)

Parameters

  • language
    Type: System..::.String
    The language for the enumeration value to delete, if the property is a multilingual property. Can be nullNothingnullptra null reference (Nothing in Visual Basic).

Exceptions

Exception Condition
ValidationException

The language is invalid.

ArgumentNullException

The enumValue is nullNothingnullptra null reference (Nothing in Visual Basic).

EntityDoesNotExistException

The enumValue does not exist in the property.

Remarks

You can use this method to remove an existing enumeration value from a property of the Enumeration datatype.

If specified, the language should:

  • Not be null or blank.

  • Not exceed 10 characters.

  • Not contain the ,'[] characters.

  • Be specified for multilingual properties only.

If specified, the enumValue should:

  • Not exceed 128 characters.

  • Be a valid enumeration value in the property.

Any new enumeration values removed from the property will be removed from the catalog system only when the Save method is called.

Permissions

See Also

Reference

CatalogEnumerationProperty Class

CatalogEnumerationProperty Members

RemoveEnumerationPropertyValue Overload

Microsoft.CommerceServer.Catalog Namespace