CatalogManager3.Properties Property (PIA)

  • Article

The Properties property is a read-only recordset that returns the name of each property that currently exists in the Product Catalog System. If the catalog name is specified, only properties used in that catalog are returned.

Definition

[Visual Basic .NET]

Imports Microsoft.CommerceServer.Interop.Catalog
Imports ADODB26Lib     ‘ for _Recordset
…
Public ReadOnly Property Properties(Optional strCatalogName As Object) As _Recordset

[C#]

using Microsoft.CommerceServer.Interop.Catalog;
using ADODB26Lib;                              //For _Recordset
…
public _Recordset get_Properties(objectstrCatalogName);

Parameters

[Visual Basic .NET]

  • strCatalogName
    An Object that contains the name of the catalog for which the properties are returned. If this optional parameter is omitted, all properties are returned.

[C#]

  • strCatalogName
    An object that contains the name of the catalog for which the properties are returned. If this optional parameter is set to Type.Missing, all properties are returned.

[C#]

Return Values

This method returns an ADODB26Lib._Recordset interface to a Recordset object used to return the properties.

Exceptions

This property 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 COM errors 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_CATALOGNAME

[C#] 0x8898006

[Visual Basic .NET] &H8898003

 The Catalog Name you specified is invalid. Catalog names cannot be blank.
E_CAT_INVALID_CATALOG_NAME_LENGTH

[C#] 0x8898004

[Visual Basic .NET] &H8898002

 The Catalog name you specified exceeds the maximum limit of 85 characters.
E_CAT_CHARACTER_NOT_ALLOWED

[C#] 0x8898003

[Visual Basic .NET] &H889800D

 The catalog name you specified has one of the nine reserved characters " [ ] , ' ( )#. which should not be used.

Remarks

[Visual Basic .NET]

The Recordset object contains valid data only if the property was accessed successfully.

This method returns a Recordset object containing a row for each property returned. For more information about the fields in this Recordset object, see PropertyAttribute Recordset.

[C#]

This method returns the _Recordset interface to a Recordset object containing a row for each property returned. For more information about the fields in this Recordset object, see PropertyAttribute Recordset.

get_Properties does not show up in IntelliSense.

[Visual Basic .NET]

Example

rsProps = myCatalogManager.Properties("ShoesCatalog")

Requirements

Namespace: Microsoft.CommerceServer.Interop.Catalog

Platforms: Windows 2000, Windows Server 2003

Assembly: cataloglib (in cataloglib.dll)

See Also

CatalogManager3 Class

CatalogManager3.CreateProperty

CatalogManager3.DeleteProperty

Copyright © 2005 Microsoft Corporation.
All rights reserved.