CatalogManager3.GetAttributes Method (PIA)

  • Article

Use this method to retrieve the catalog or property attributes in the Product Catalog System.

Definition

[Visual Basic .NET]

Imports Microsoft.CommerceServer.Interop.Catalog
Imports ADODB26Lib     ‘ for _Recordset
…
Public Function GetAttributes(eAttributeType As CatalogAttributesEnum,
  Optional fUserDefinedOnly As Boolean) As Recordset

[C#]

using Microsoft.CommerceServer.Interop.Catalog;
using ADODB26Lib;                              //For _Recordset
…
public _Recordset GetAttributes(CatalogAttributeEnumeAttributeType,
  Boolean fUserDefinedOnly);

Parameters

[Visual Basic .NET]

  • eAttributeType
    A CatalogAttributesEnum enumeration that specifies whether to return catalog or property attributes. See the Remarks section for valid values.
  • fUserDefinedOnly
    A Boolean that specifies whether to return only user-defined attributes. A value of True specifies returning only user-defined attributes. A value of False specifies returning all attributes. The default value is True.

[C#]

  • eAttributeType
    A CatalogAttributesEnum enumeration that specifies whether to return catalog or property attributes. See the Remarks section for valid values.
  • fUserDefinedOnly
    A Boolean that specifies whether to return only user-defined attributes. A value of True specifies returning only user-defined attributes. A value of False specifies returning all attributes. The default value is True.

Return Values

[Visual Basic .NET] If this method completes successfully, it returns a Recordset object that contains the properties of the specified definition.

[C#] This method returns an ADODB26Lib._Recordset interface to a Recordset object used to return the properties of the definition.

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_PARAMETER

[C#] 0x889800B

[Visual Basic .NET] &H8898006

 The input parameter <parameter number> is invalid.

Remarks

The following table shows the values in the CatalogAttributesEnum enumeration, and shows their associated names, and describes their use.

Name Value Description
cscPropertyAttributes 0 Returns property attributes.
cscCatalogAttributes 1 Returns catalog attributes.

For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.

Requirements

Namespace: Microsoft.CommerceServer.Interop.Catalog

Platforms: Windows 2000, Windows Server 2003

Assembly: cataloglib (in cataloglib.dll)

See Also

CatalogManager3 Class

Copyright © 2005 Microsoft Corporation.
All rights reserved.