CatalogManager3.GetPropertyValues Method (PIA)

  • Article

Use this method to return the list of values defined for an enumeration property.

Definition

[Visual Basic .NET]

Imports Microsoft.CommerceServer.Interop.Catalog
Imports ADODB26Lib     ‘ for _Recordset
…
Public Function GetPropertyValues(strPropertyName As String) As _Recordset

[C#]

using Microsoft.CommerceServer.Interop.Catalog;
using ADODB26Lib;                              //For _Recordset
…
public _Recordset GetPropertyValues(stringstrPropertyName);

Parameters

[Visual Basic .NET]

  • strPropertyName
    A String that contains the name of the enumeration property for which the defined values will be returned.

[C#]

  • strPropertyName
    A string that contains the name of the enumeration property for which the defined values will be returned.

Return Values

[Visual Basic .NET] If this method completes successfully, it returns the _Recordset interface to a Recordset object that contains the defined values in the enumeration.

[C#] This method returns a _ADODB26Lib._Recordset interface to a Recordset object used to return the property values.

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_RS_POINTER

[C#] 0x889800B

[Visual Basic .NET] &H8898007

 The recordset pointer that you specified is invalid.
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 .,"[]

Remarks

[Visual Basic .NET] The returned recordset contains valid data only if the method completes successfully.

[C#] The returned interface is associated with valid data only if the method completes successfully.

The returned Recordset contains the following fields:

Field Data Type Description
PropertyName String
256 characters		 None
Value String
256 characters		 None

[Visual Basic .NET]

Example

rsEnumValues = myCatalogManager.GetPropertyValues("Color")

Requirements

Namespace: Microsoft.CommerceServer.Interop.Catalog

Platforms: Windows 2000, Windows Server 2003

Assembly: cataloglib (in cataloglib.dll)

See Also

CatalogManager3 Class

CatalogManager3.AddPropertyValue

CatalogManager3.RemovePropertyValue

Copyright © 2005 Microsoft Corporation.
All rights reserved.