IProductCatalog::GetCustomCatalogAttributes

Ee796754.c++_off(en-US,CS.10).gifEe796754.vb_on(en-US,CS.10).gif

Use this method to retrieve the attributes for a specified custom catalog.

Definition

HRESULT IProductCatalog::GetCustomCatalogAttributes(BSTRstrCCName,_Recordset**ppRSCustomCatalog);

Parameters

strCCName

[in] A BSTR that contains the name of the custom catalog.

ppRSCustomCatalog

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

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

The ppRSCustomCatalog parameter contains valid data only if the method competed successfully.

The following table shows the fields that the returned single-row recordset contains. 

Field Data Type Description
CustomCatalogName String
Maximum of 128 unicode characters
The name of the custom catalog.
CatalogName String
Maximum of128 unicode characters
The name of the base catalog.
CustomCatalogID Integer The field name that uniquely identifies custom catalogs.
TimeStamp Timestamp None.

The returned recordset is disconnected and updateable. The CustomCatalogName parameter is the only field that can be modified.

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

See Also

ProductCatalog Object

IProductCatalog::CreateCustomCatalog

IProductCatalog::SetCustomCatalogAttributes


All rights reserved.