Share via


ICategory::get_GetCategoryProperties

Ee824739.c++_off(en-US,CS.10).gifEe824739.vb_on(en-US,CS.10).gif

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

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

Parameters

GetCategoryProperties

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

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_CATEGORY_DOESNT_EXIST 0x8898001C This category has been removed from the catalog.

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 GetCategoryProperties parameter contains valid data only if the property is accessed successfully.

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.

See Also

Category Object

ICategory::SetCategoryProperties


All rights reserved.