ICategory3::get_GetCategoryProperties Property [C++]

Article
11/12/2009

The GetCategoryProperties property is a read-only recordset that contains the properties for this category. Both the properties that are present in the definition of this category, and the built-in properties, are returned.

Definition

[C++]

HRESULT ICategory3::get_GetCategoryProperties(_Recordset**GetCategoryProperties);

[Visual Basic]

Property GetCategoryProperties As Recordset

Parameters

GetCategoryProperties[C++]
[out, retval] A _Recordset object used to return the category properties.

[Visual Basic] None.

[C++]

Return Values

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

Error Values

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

[Visual Basic] This property 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_INVALID_RS_POINTER	[C++] 0x889800B7 [Visual Basic] &H889800B7	The recordset pointer that you specified is invalid
E_CAT_INVALID_OPERATION_FOR_ROOT_CATEGORY	[C++] 0x889800F8 [Visual Basic] &H889800F8	This API cannot be called for a root category.
E_CAT_CATEGORY_DOESNT_EXIST	[C++] 0x8898001C [Visual Basic] &H8898001C	The category you specified doesn't exist.

E_CAT_INVALID_RS_POINTER

[C++] 0x889800B7

[Visual Basic] &H889800B7

The recordset pointer that you specified is invalid

E_CAT_INVALID_OPERATION_FOR_ROOT_CATEGORY

[C++] 0x889800F8

[Visual Basic] &H889800F8

This API cannot be called for a root category.

E_CAT_CATEGORY_DOESNT_EXIST

[C++] 0x8898001C

[Visual Basic] &H8898001C

The category you specified doesn't exist.

[C++] 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] Additional information may be available using the global Err object. In particular, the Description property may contain a text description of the error.

Remarks

[C++] The GetCategoryProperties parameter contains valid data only if the property is accessed successfully.

[Visual Basic] The GetCategoryProperties property contains valid data only if the property is accessed successfully.

[C++] The returned recordset contains all the common fields in the CatalogProduct Recordset. It also contains all the fields that are in the product definitions for the category. The ProductID field (the unique product identifier) is returned even if it is not part of a product definition.

[Visual Basic] The returned recordset contains all the common fields in the CatalogProduct Recordset. It also contains all the fields that are in the product definitions for the category. The ProductID field (the unique product identifier) is returned even if it is not part of a product definition.

The recordset returned is updateable, but disconnected. If this category has been deleted from the database, this property returns an error. For categories created in virtual catalogs, the category name returned in the recordset will not contain the appended catalog name.