IProductCatalog::GetCatalogAttributes

Article
06/07/2013

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

Use this method to retrieve the attributes of this catalog. The returned recordset is disconnected and updateable.

Definition

HRESULT IProductCatalog::GetCatalogAttributes(_Recordset**ppRSCatalogAttributes);

Parameters

ppRSCatalogAttributes

[out, retval] A pointer to a Recordset used to return the attributes of this catalog.

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 standard COM HRESULT error values to indicate failure. For more information about standard COM errors, see Standard COM Errors. 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

Ther ppRSCatalogAttributes parameter contains valid data only if the property was accessed successfully.

The returned recordset is disconnected and updateable. The following table shows the fields that the returned recordset contains.

Field	Data Type	Description
CatalogName	String 128 characters	The name of the catalog.
Locale	Integer	None.
StartDate	Datetime	None.
End Date	Datetime	None.
VariantID	String 128 characters	The field name that uniquely identifies variants.
ProductID	String 128 characters	The field name that uniquely identifies products.
Currency	String 128 characters	None.
WeightMeasure	String 128 characters	None.
TimeStamp	Timestamp	None.
CatalogID	Integer	None.
CustomCatalog	Boolean	A flag indicating whether this is a custom catalog. True indicates a custom catalog.
FreeTextIndexCreated	Datetime	None.
ProductTableUpdated	Datetime	None.

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