ProductCatalog Object [C++]
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 |
| Type Library Name: | Microsoft Commerce 2002 Catalog Type Library |
| DLL Name: | Catalog.dll |
| Threading Model: | Both |
[C++]
| COM Interface Name: | IProductCatalog3 |
| Interface ID Constant: | IID_IProductCatalog3 |
| Header File: | Catalog.h, mspu_guids.h |
[C++]
In C++, use the IProductCatalog3 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.
Methods
[C++]
| Method | Description |
|---|---|
| AddLanguage | Adds support for an additional language. |
| AddPriceRule | Adds a price rule for a specific product or category to a virtual catalog. |
| AddSpecificationSearchClause | Adds a search constraint to the search context when performing a specification search of this catalog. |
| AddVirtualCatalogRule | Adds an inclusion or exclusion rule for a specific product, category, variant, or catalog to the current catalog. |
| BeginSpecificationSearch | Initiates a specification search of this catalog. |
| CreateCategory | Creates a new category based on the specified category definition. |
| CreateCustomCatalog | This method is obsolete. |
| CreateProduct | Creates a new product or product family based on the specified product definition. |
| DeleteCategory | Deletes the specified category from this catalog. |
| DeleteCustomCatalog | This method is obsolete. |
| DeleteProduct | Deletes the specified product from this catalog. |
| GenerateCustomCatalog | This method is obsolete. |
| GetCatalogAttributes | Returns the attributes of this catalog. The returned recordset is disconnected and updateable. |
| GetCategory | Returns the specified category. |
| GetCategoryCustomPrice | This method is obsolete. |
| GetCustomCatalogAttributes | This method is obsolete. |
| GetDependentCatalogs | Returns a recordset with a single field containing all of the virtual catalogs that are dependant on this catalog. |
| GetLanguages | Returns a recordset with a single field containing all of the supported languages. |
| GetPriceRules | Returns a recordset containing the specified price rules. |
| 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. |
| GetVirtualCatalogRules | Returns a recordset containing the specified virtual catalog rules. |
| 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. |
| Purge | Removes deleted products from the catalog table. |
| RebuildVirtualCatalog | Use this method to rebuild virtual catalogs. |
| RegenerateFreeTextSearchIndex | Updates the free text search index for this catalog. |
| RemoveLanguage | Removes the specified language from this catalog. |
| RemovePriceRule | Removes the specified price rule. |
| RemoveSpecificationSearchClause | Removes the last search constraint from the specified search context. |
| RemoveVirtualCatalogRule | Removes the specified virtual catalog rule. |
| SetCatalogAttributes | Sets attributes for this catalog. |
| SetCategoryCustomPrice | This method is obsolete. |
| SetCustomCatalogAttributes | This method is obsolete. |
[Visual Basic]
| Method | Description |
|---|---|
| AddLanguage | Adds support for an additional language. |
| AddPriceRule | Adds a price rule for a specific product or category to a virtual catalog. |
| AddSpecificationSearchClause | Adds a search constraint to the search context when performing a specification search of this catalog. |
| AddVirtualCatalogRule | Adds an inclusion or exclusion rule for a specific product, category, variant, or catalog to the current catalog. |
| BeginSpecificationSearch | Initiates a specification search of this catalog. |
| CreateCategory | Creates a new category based on the specified category definition. |
| CreateCustomCatalog | This method is obsolete. |
| CreateProduct | Creates a new product based on the specified product definition. |
| DeleteCategory | Deletes the specified category from this catalog. |
| DeleteCustomCatalog | This method is obsolete. |
| DeleteProduct | Deletes the specified product from this catalog. |
| GenerateCustomCatalog | This method is obsolete. |
| GetCatalogAttributes | Returns the attributes of this catalog. The returned recordset is disconnected and updateable. |
| GetCategory | Returns the specified category. |
| GetCategoryCustomPrice | This method is obsolete. |
| GetCustomCatalogAttributes | This method is obsolete. |
| GetDependentCatalogs | Returns a recordset with a single field containing all of the virtual catalogs that are dependant on this catalog. |
| GetLanguages | Returns a recordset with a single field containing all of the supported languages. |
| GetPriceRules | Returns a recordset containing the specified price rules. |
| 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. |
| GetVirtualCatalogRules | Returns a recordset containing the specified virtual catalog rules. |
| 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. |
| Purge | Removes deleted products from the catalog table. |
| RebuildVirtualCatalog | Use this method to rebuild virtual catalogs. |
| RegenerateFreeTextSearchIndex | Updates the free text search index for this catalog. |
| RemoveLanguage | Removes the specified language from this catalog. |
| RemovePriceRule | Removes the specified price rule. |
| RemoveSpecificationSearchClause | Removes the last search constraint from the specified search context. |
| RemoveVirtualCatalogRule | Removes the specified virtual catalog rule. |
| SetCatalogAttributes | Sets attributes for this catalog. |
| SetCategoryCustomPrice | This method is obsolete. |
| SetCustomCatalogAttributes | This method is obsolete. |
Properties
[C++]
| Property | Type | Description |
|---|---|---|
| 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. |
| Language | BSTR | Contains the active language.
This property is read/write. |
| 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. |
[Visual Basic]
| Property | Type | Description |
|---|---|---|
| CatalogName | String | Contains the name of this catalog.
This property is read-only. |
| IdentifyingProductProperty | String | Contains the name of the column used to uniquely identify products and product families.
This property is read-only. |
| IdentifyingVariantProperty | String | Contains the name of the column used to uniquely identify product variants.
This property is read-only. |
| Language | String | Contains the active language.
This property is read/write. |
| 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. |
Remarks
[C++]
Many of the methods in ProductCatalog use recordsets to return data. These methods will often use the CatalogProduct recordset. For more information, see CatalogProduct recordset.
The ProductCatalog object is a dependent object. Obtain a pointer to the IProductCatalog interface by calling one of the following methods:
[Visual Basic]
Many of the methods in ProductCatalog use recordsets to return data. These methods will often use the CatalogProduct recordset. For more information, see CatalogProduct recordset.
The ProductCatalog object is a dependent object. Obtain a reference to it by calling one of the following methods:
Copyright © 2005 Microsoft Corporation.
All rights reserved.