CatalogManager Object [C++]
Use this object to work with the entire Product Catalog System. The methods and properties of this object affect all catalogs contained in the Product Catalog System.
| ProgID: | Commerce.CatalogManager (Externally creatable) |
| COM Class Name: | CatalogManager |
| Type Library Name: | Microsoft Commerce 2002 Catalog Type Library v1.3 |
| DLL Name: | Catalog.dll |
| Threading Model: | Both |
[C++]
| COM Interface Name: | ICatalogManager3 |
| Interface ID Constant: | IID_ICatalogManager3 |
| Header File: | Catalog.h, mspu_guids.h |
[C++]
In C++, use the ICatalogManager3 interface to access the properties and methods of the CatalogManager object. The ICatalogManager interface exists in Microsoft Commerce Server 2000 and later versions. The ICatalogManager2 interface exists in Microsoft Commerce Server 2000 SP1 and later versions.The ICatalogManager3 interface is the default interface for the CatalogManager object and is backward compatible with the previous interfaces.
Because this object is primarily intended for use within ASP script, access from C++ will not be common.
Methods
[C++]
| Method | Description |
|---|---|
| AddCatalogAttribute | Adds an attribute to a catalog. |
| AddDefinitionProperty | Adds a property to a definition. |
| AddDefinitionVariantProperty | Adds a variant property to a definition. |
| AddPropertyAttribute | Adds an attribute to a property. |
| AddPropertyValue | Adds a value to the list of defined values for this property. Only applies to enumerations. |
| CreateCatalog | Creates a new catalog. |
| CreateCategoryDefinition | Creates a new category definition. |
| CreateProductDefinition | Creates a new product definition. |
| CreateProperty | Creates a new property. |
| DeleteCatalog | Deletes a catalog. |
| DeleteDefinition | Deletes a product or category definition. |
| DeleteProperty | Deletes a property. |
| DeltaExportXML | Exports updated catalog data as an Extensible Markup Language (XML)-formatted file. |
| ExportCSV | Exports catalog data as a comma-separated values (CSV)-formatted file. |
| ExportXML | Exports catalog data as an XML-formatted file. |
| FreeTextSearch | Performs a free-text search of catalogs. |
| GetAttributes | Returns the catalog or property attributes in the Product Catalog System. |
| GetCatalog | Returns the specified catalog object. |
| GetDefinitionProperties | Returns the properties of a specified definition. |
| GetPropertyAttributes | Returns all the attributes of a specified property. |
| GetPropertyValues | Returns a list of appropriate values for an enumeration property. |
| ImportCSV | Imports a CSV-formatted file as catalog data. |
| ImportXML | Imports an XML-formatted file as catalog data. |
| Initialize | Initializes the CatalogManager object. |
| Query | Performs queries against product, variant, and category data in one or more catalogs. |
| RebuildAllVirtualCatalogs | Rebuilds all virtual catalogs. |
| RemoveCatalogAttribute | Removes the specified attribute from a catalog. |
| RemoveDefinitionProperty | Removes the specified property or variant property from a definition. |
| RemovePropertyAttribute | Removes the specified attribute from a property. |
| RemovePropertyValue | Removes a defined value from an enumeration property. |
| RenameDefinition | Renames a definition. |
| RenameProperty | Renames a property. |
| Search | Performs language-specific searches in one or more catalogs. |
| SetDefinitionProperties | Changes the properties of a category or product definition. |
| SetJoinTable | Joins an external table to a table in the Product Catalog System. |
| SetPropertyAttributes | Changes the attributes of a property. |
| ValidateXML | Validates an XML-formatted file against the catalog definition. |
[Visual Basic]
| Method | Description |
|---|---|
| AddCatalogAttribute | Adds an attribute to a catalog. |
| AddDefinitionProperty | Adds a property to a definition. |
| AddDefinitionVariantProperty | Adds a variant property to a definition. |
| AddPropertyAttribute | Adds an attribute to a property. |
| AddPropertyValue | Adds a value to the list of defined values for this property. Only applies to enumerations. |
| CreateCatalog | Creates a new catalog. |
| CreateCategoryDefinition | Creates a new category definition. |
| CreateProductDefinition | Creates a new product definition. |
| CreateProperty | Creates a new property. |
| DeleteCatalog | Deletes a catalog. |
| DeleteDefinition | Deletes a product or category definition. |
| DeleteProperty | Deletes a property. |
| DeltaExportXML | Exports updated catalog data as an Extensible Markup Language (XML)-formatted file. |
| ExportCSV | Exports catalog data as a comma-separated values (CSV)-formatted file. |
| ExportXML | Exports catalog data as an XML-formatted file. |
| FreeTextSearch | Performs a free-text search of catalogs. |
| GetAttributes | Returns the catalog or property attributes in the Product Catalog System. |
| GetCatalog | Returns the specified catalog object. |
| GetDefinitionProperties | Returns the properties of a specified product or category definition. |
| GetPropertyAttributes | Returns all the attributes of a specified property. |
| GetPropertyValues | Returns a list of appropriate values for an enumeration property. |
| ImportCSV | Imports a CSV-format file as catalog data. |
| ImportXML | Imports an XML-formatted file as catalog data. |
| Initialize | Initializes the CatalogManager object. |
| Query | Performs queries against product, variant, and category data in one or more catalogs. |
| RebuildAllVirtualCatalogs | Rebuilds all virtual catalogs. |
| RemoveCatalogAttribute | Removes the specified attribute from a catalog. |
| RemoveDefinitionProperty | Removes the specified property or variant property from a definition. |
| RemovePropertyAttribute | Removes the specified attribute from a property. |
| RemovePropertyValue | Removes a defined value from an enumeration property. |
| RenameDefinition | Renames a definition. |
| RenameProperty | Renames a property. |
| Search | Performs language-specific searches in one or more catalogs. |
| SetDefinitionProperties | Changes the properties of a category or product definition. |
| SetJoinTable | Joins an external table to a table in the Product Catalog System. |
| SetPropertyAttributes | Changes the attributes of a property. |
| ValidateXML | Validates an XML-formatted file against the catalog definition. |
Properties
[C++]
| Property | Type | Description |
|---|---|---|
| Catalogs | _Recordset | Returns a recordset containing a record for each catalog contained in the Product Catalog System, including their properties.
This property is read-only. |
| CategoryDefinitions | _Recordset | Returns a recordset containing the names of all of the category definitions that currently exist in the Product Catalog System.
This property is read-only. |
| CustomCatalogs | _Recordset | This property is obsolete. |
| ProductDefinitions | _Recordset | Returns a recordset containing the names of all the product definitions that currently exist in the Product Catalog System.
This property is read-only. |
| Properties | _Recordset | Returns a recordset containing the name of each property that currently exists in the Product Catalog System.
This property is read-only. |
[Visual Basic]
| Property | Type | Description |
|---|---|---|
| Catalogs | _Recordset | Returns a recordset containing a record for each catalog contained in the Product Catalog System, including their properties.
This property is read-only. |
| CategoryDefinitions | _Recordset | Returns a recordset containing the names of all of the category definitions that currently exist in the Product Catalog System.
This property is read-only. |
| CustomCatalogs | _Recordset | This property is obsolete. |
| ProductDefinitions | _Recordset | Returns a recordset containing the names of all the product definitions that currently exist in the Product Catalog System.
This property is read-only. |
| Properties | _Recordset | Returns a recordset containing the name of each property that currently exists in the Product Catalog System.
This property is read-only. |
Recordsets
| Recordset | Description |
|---|---|
| PropertyAttribute | The default property definitions found in the CatalogAttributes table. |
This topic also contains a list of Language Culture Names, Display Names, Culture Codes, and ISO 639x values that are used by Commerce Server. For more information, see Table of Language Culture Names, Codes, and ISO Values.
Remarks
Some methods of the CatalogManager object cannot be called in a transacted object. These methods are CreateCatalog, DeleteCatalog, GenerateCustomCatalog, ImportCSV, ImportXML, and RegenerateFreeTextSearchIndex. These methods involve the creation, deletion, or updating of free text indexes. SQL Server does not allow these operations in a transaction.
Binding to the CatalogManager object in a COM+ component that has either the Required or Requires NewTransaction property set generates a run time error.
See Also
User-defined Property and Catalog Attributes
Copyright © 2005 Microsoft Corporation.
All rights reserved.