CatalogManager3.GetPropertyAttributes Method (PIA)

  • Article

Use this method to return the attributes of the specified property.

Definition

[Visual Basic .NET]

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

[C#]

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

Parameters

[Visual Basic .NET]

  • strPropertyName
    A String that contains the name of the property whose attributes will be returned.

[C#]

  • strPropertyName
    A string that contains the name of the property whose attributes will be returned.

Return Values

[Visual Basic .NET] If this method completes successfully, it returns a Recordset object that contains the list of attributes for the specified property

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

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 describes the exceptions that 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 PropertyName 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

The recordset returned by this method contains valid data only if the method completes successfully.

This method returns a single-row Recordset object containing the requested property. For more information about the fields in this Recordset object, see PropertyAttribute Recordset.

[Visual Basic .NET]

Example

rsPropAttribs = myCatalogManager.GetPropertyAttributes("Size")

Requirements

Namespace: Microsoft.CommerceServer.Interop.Catalog

Platforms: Windows 2000, Windows Server 2003

Assembly: cataloglib (in cataloglib.dll)

See Also

CatalogManager3 Class

CatalogManager3.SetPropertyAttributes

Copyright © 2005 Microsoft Corporation.
All rights reserved.