ProductCatalog Object
.gif "Ee783834.c++_off(en-US,CS.10).gif")
.gif "Ee783834.vb_on(en-US,CS.10).gif")
Use this object to alter catalogs and to modify catalog contents. The ProductCatalog object is the primary object for working with catalogs in the Product Catalog System.
| ProgID: | Dependent (See Remarks for more information) |
| COM Class Name: | ProductCatalog |
| COM Interface Name: | IProductCatalog |
| Interface ID Constant: | IID_IProductCatalog |
| Header File: | Catalog.h, mspu_guids.h |
| Type Library Name: | Microsoft Commerce 2000 Catalog Type Library |
| DLL Name: | Catalog.dll |
| Threading Model: | Both |
In C++, use the IProductCatalog interface to access the properties and methods of the ProductCatalog object.
Because this object is primarily intended for use within ASP script, access from C++ will not be common.
The properties of the ProductCatalog object are shown in the following table.
| Property | Type | Description |
| BaseCatalogName | BSTR | Contains the name of a base catalog for a custom catalog.
This property is read-only. |
| CatalogName | BSTR | Contains the name of this catalog.
This property is read-only. |
| IdentifyingProductProperty | BSTR | Contains the name of the column used to uniquely identify products and product families.
This property is read-only. |
| IdentifyingVariantProperty | BSTR | Contains the name of the column used to uniquely identify product variants.
This property is read-only. |
| RootCategories | _Recordset | Returns a recordset containing the names of categories that are the root categories for this catalog.
This property is read-only. |
| RootProducts | _Recordset | Returns a recordset containing the products that are part of this catalog, but are not contained in any category.
This property is read-only. |
| SearchableCategories | _Recordset | Returns a recordset with a single field that contains the names of the categories that are defined as searchable.
This property is read-only. |
The methods of the ProductCatalog object are shown in the following table.
| Method | Description |
| AddSpecificationSearchClause | Adds a search constraint to the search context when performing a specification search of this catalog. |
| BeginSpecificationSearch | Initiates a specification search of this catalog. |
| CreateCategory | Creates a new category based on the specified category definition. |
| CreateCustomCatalog | Creates a new custom catalog template. The returned recordset is disconnected and updateable. |
| CreateProduct | Creates a new product or product family based on the specified product definition. |
| DeleteCategory | Deletes a category from this catalog. |
| DeleteCustomCatalog | Deletes a custom catalog from this catalog. |
| DeleteProduct | Deletes a product from this catalog. |
| GenerateCustomCatalog | Populates the specified custom catalog template with data derived from this catalog. |
| GetCatalogAttributes | Returns the attributes of this catalog. The returned recordset is disconnected and updateable. |
| GetCategory | Returns the specified category. |
| GetCategoryCustomPrice | Returns the custom price of the specified category. |
| GetCustomCatalogAttributes | Returns the attributes of the specified custom catalog. The returned recordset is disconnected and updateable. |
| GetProduct | Returns the specified product. |
| GetProductVariant | Returns a recordset with a single row containing all of the properties for the specified product variant. |
| GetSpecificationSearchClauses | Returns a recordset with a single field containing all of the search clauses for a specification search. |
| GuaranteedSpecificationSearch | Performs a specification search in which search constraints are removed until a match is found. |
| PerformSpecificationSearch | Performs a specification search of this catalog using the specified search context. |
| RegenerateFreeTextSearchIndex | Updates the free text search index for this catalog. |
| RemoveSpecificationSearchClause | Removes the last search constraint from the specified search context. |
| SetCatalogAttributes | Sets attributes for this catalog. |
| SetCategoryCustomPrice | Defines a custom price for the specified category. |
| SetCustomCatalogAttributes | Sets attributes for the specified custom catalog. |
Remarks
The ProductCatalog object is a dependent object. Obtain a pointer to the IProductCatalog interface by calling one of the following methods:
.gif "Ee783834.note(en-US,CS.10).gif")
Note
- There is limit on the number of ProductCatalogs objects upon which you can search. Above 256 ProductCatalog objects, full-text search will break. This is a limitation of SQL Server 2000.