Share via


IProductCatalog::get_SearchableCategories

Ee798117.c++_off(en-US,CS.10).gifEe798117.vb_on(en-US,CS.10).gif

The SearchableCategories property is a read-only recordset that contains the names of all searchable categories.

Definition

HRESULT IProductCatalog::get_SearchableCategories(_Recordset**SearchableCategories);

Parameters

SearchableCategories

[out, retval] A Recordset used to return the names of the searchable categories.

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

The SearchableCategories property returns the names of all the categories in this catalog that can be queried using a specification search. Whether or not a particular category is specification searchable is determined by the value of the IsSearchable attribute. This property can be set at the time the category is created, or can be changed at any time using the SetCategoryProperties methods of the category object.

The Recordset object returned by this property will contain a single 128-character field called Name. Each row will contain the name of a searchable category.

If there are no searchable categories, a recordset with its EOF property set to VARIANT_TRUE will be returned.

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

See Also

ProductCatalog Object

IProductCatalog::CreateCategory

IProductCatalog::GetCategory


All rights reserved.