ICatalogManager::GetDefinitionProperties

Article
06/07/2013

Ee811515.vb_on(en-US,CS.10).gif

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

Definition

HRESULT ICatalogManager::GetDefinitionProperties(BSTRstrDefinitionName,_Recordset**ppRSProperties);

Parameters

strDefinitionName

[in] A BSTR that contains the name of the definition whose properties will be returned.

ppRSProperties

[out, retval] A pointer to a _Recordset object used to return the properties of the definition.

Return Values

This method returns an HRESULT indicating whether it completed successfully. See the Error Values section for more details.

Error Values

This method returns S_OK (0x00000000) to indicate success and either standard or custom COM HRESULT 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	0x8898000B	The specified definition did not exist.

Additional information may be available using the global Err object, which can be accessed using the API function GetErrorInfo. In particular, the GetDescription method of the IErrorInfo interface may return a text description of the error.

Remarks

The ppRSProperties parameter 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.

Share via