CatalogManager3.GetDefinitionProperties Method (PIA)

  • Article

Use this method to return the properties of the specified catalog or product definition.

Definition

[Visual Basic .NET]

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

[C#]

using Microsoft.CommerceServer.Interop.Catalog;
using ADODB26Lib;                              //For _Recordset
…
public _Recordset GetDefinitionProperties(stringstrDefinitionName);

Parameters

[Visual Basic .NET]

  • strDefinitionName
    A String that contains the name of the definition whose properties will be returned.

[C#]

  • strDefinitionName
    A string that contains the name of the definition whose properties will be returned.

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_DEFINITION_LENGTH

[C#] 0x889800E

[Visual Basic .NET] &H889800A

 The definition name that you specified is invalid. Definition names should be between 1 and 128 characters in length.
E_CAT_DEFINITION_DOESNT_EXIST

[C#] 0x8898000

[Visual Basic .NET] &H889800B

 The Definition you specified does not exist.

Remarks

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

The returned Recordset contains the following fields:

Field Data Type Description
DefinitionID Integer The number that uniquely identifies the definition.
PropertyName String, 256 characters None
PropertyOrder Integer None
PropertyType Integer Zero (0) indicates product or category, one (1) indicates product variant.
TimeStamp Timestamp None

The rows of the Recordset are sorted on the PropertyOrder field.

[Visual Basic .NET]

Example

rsDefProps = myCatalogManager.GetDefinitionProperties("T-Shirts")

Requirements

Namespace: Microsoft.CommerceServer.Interop.Catalog

Platforms: Windows 2000, Windows Server 2003

Assembly: cataloglib (in cataloglib.dll)

See Also

CatalogManager3 Class

CatalogManager3.AddDefinitionProperty

CatalogManager3.AddDefinitionVariantProperty

CatalogManager3.RemoveDefinitionProperty

Copyright © 2005 Microsoft Corporation.
All rights reserved.