ProductCatalog3.RebuildVirtualCatalog Method (PIA)
Use this method to rebuild a virtual catalog or all dependent virtual catalogs.
Definition
[Visual Basic .NET]
Imports Microsoft.CommerceServer.Interop.Catalog
…
Public Sub RebuildVirtualCatalog(Optional fRunSynchronously As Object,
Optional fForceRebuild As Object)
[C#]
using Microsoft.CommerceServer.Interop.Catalog;
…
public void MethodName(object fRunSynchronously,
object fForceRebuild);
Parameters
[Visual Basic .NET]
- fRunSynchronously
A Boolean that specifies whether to run the method synchronously. A value of True indicates that the method should be run synchronously. A value of False indicates that the method should be run asynchronously. The default value is False. - fForceRebuild
A Boolean that specifies whether to force a rebuild. A value of True indicates that all catalogs will be rebuilt regardless of status. A value of False indicates that only dirty catalogs will be rebuilt. The default value is False.
[C#]
- fRunSynchronously
A Boolean that specifies whether to run the method synchronously. A value of True indicates that the method should be run synchronously. A value of False indicates that the method should be run asynchronously. The default value is False. - fForceRebuild
A Boolean that specifies whether to force a rebuild. A value of True indicates that all catalogs will be rebuilt regardless of status. A value of False indicates that only dirty catalogs will be rebuilt. The default value is False.
Exceptions
This method may throw one of many mapped exceptions or an exception of type COMException. See Standard COM Errors for additional details.
The following table shows the custom COM errors that COMException may wrap as exceptions for this method.
| Constant | Value | Description |
|---|---|---|
| E_CAT_CATALOG_DOESNT_EXIST | [C#] 0x88980002 [Visual Basic .NET] &H88980002 |
The catalog name you specified does not exist. |
Remarks
If the fForceRebuild parameter is not set to True, virtual catalogs will only be rebuilt if there has been a rule change, a product deletion, or a category deletion that would affect the contents of the catalog*.* If this method is called on a base catalog, it will apply to all virtual catalogs that include products or categories from the base catalog. If this method is called on a virtual catalog, it will apply only to the virtual catalog.
If you want to rebuild all the virtual catalogs in the Product Catalog System, use ICatalogManager3::RebuildAllVirtualCatalogs
For more information about memory ownership issues related to COM property and method parameters, see Managing COM Parameter Memory.
Requirements
Namespace: Microsoft.CommerceServer.Interop.Catalog
Platforms: Windows 2000, Windows Server 2003
Assembly: cataloglib (in cataloglib.dll)
See Also
Copyright © 2005 Microsoft Corporation.
All rights reserved.