Share via


CatalogManager.GetDefinitionProperties

Ee811513.c++_on(en-US,CS.10).gifEe811513.vb_off(en-US,CS.10).gif

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

Definition

Function GetDefinitionProperties(strDefinitionName As String) As _Recordset

Parameters

strDefinitionName

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

Return Values

If this method completes successfully, it returns a Recordset that contains the properties of the specified definition.

Error Values

This method sets the Number property of the global Err object to S_OK (&H00000000) to indicate success and to either standard or custom COM error values to indicate failure. For more information about standard COM errors, see Standard COM Errors.

The following table shows the custom COM errors that this method can return.

Constant Value Description
E_CAT_DEFINITION_DOESNT_EXIST &H8898000B The specified definition did not exist.

Additional information may be available using the global Err object. In particular, the Description property may contain a text description of the error.

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.

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

Example

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

See Also

CatalogManager Object

CatalogManager.AddDefinitionProperty

CatalogManager.AddDefinitionVariantProperty

CatalogManager.RemoveDefinitionProperty


All rights reserved.