Share via

IProductCatalog3::GetCatalogAttributes Method [C++]

  • Article

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

Definition

[C++]

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

[Visual Basic]

Function GetCatalogAttributes() As _Recordset

Parameters

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

[Visual Basic] None.

Return Values

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

[Visual Basic] If this method completes successfully, it returns a recordset that contains the attributes of this catalog.

Error Values

[C++] 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.

[Visual Basic] This method sets the Number property of the global Err object to S_OK (&H00000000) to indicate success and to standard COM 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. In particular, the Description property may contain a text description of the error.

[C++] The following table shows the custom COM error that this method can return.

Constant Value Description
E_CAT_INVALID_RS_POINTER

[C++] 0x889800B7

[Visual Basic] &H889800B7

 The recordset pointer that you specified is invalid.

Remarks

[C++] The ppRSCatalogAttributes parameter contains valid data only if the method 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 Bit AReserved for future use.
FreeTextIndexCreated DateTime None
ProductTableUpdated DateTime None
FullTextCatalog String
128 characters		 The SQL full-text catalog associated with this catalog.
DefaultLanguage String
10 characters		 The default language for this catalog.
ReportingLanguage String
10 characters		 The reporting language for this catalog.
IsVirtualCatalog Boolean A flag indicating whether this is a virtual catalog. True indicates a virtual catalog.
VirtualCatalogStatus SmallInt Reserved for future use.
<UserDefinedAttributes>    
DisplayName String
128 characters		 The DisplayName for the current language of this catalog.
DisplayName_<Language> String
128 characters		 One field for each language supported by this catalog.

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

[Visual Basic]

Example

SET rsMyCatAttribs = myProductCatalog.GetCatalogAttributes

See Also

[C++]ProductCatalog Object

[Visual Basic]ProductCatalog Object

[C++]IProductCatalog3::SetCatalogAttributes

[Visual Basic]ProductCatalog.SetCatalogAttributes

Copyright © 2005 Microsoft Corporation.
All rights reserved.