ICatalogManager3::RebuildAllVirtualCatalogs Method [C++]

Article
11/12/2009

Use this method to rebuild all the virtual catalogs in the Product Catalog System.

Definition

[C++]

HRESULT ICatalogManager3::RebuildAllVirtualCatalogs(VARIANT_BOOLfRunSynchronously,
  VARIANT_BOOLfForceRebuild);

[Visual Basic]

Sub RebuildAllVirtualCatalogs(Optional fRunSynchronously As Boolean,
  Optional fForceRebuild As Boolean)

Parameters

fRunSynchronously[C++]
[in, optional, defaultvalue (0)] A VARIANT_BOOL 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.
fRunSynchronously[Visual Basic]
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 [C++]
[in, optional, defaultvalue (0)] A VARIANT_BOOL that specifies whether to force a rebuild. A value of True indicates that all catalogs will be rebuild. A value of False indicates that only dirty catalogs will be rebuilt.
fForceRebuild[Visual Basic]
A Boolean that specifies whether to force a rebuild. A value of True indicates that all catalogs will be rebuild. A value of False indicates that only dirty catalogs will be rebuilt. The default value is False.

Return Values

[C++] This method returns an HRESULT indicating whether it completed successfully. See the Error Values section for more details.

[Visual Basic] None.

Error Values

[C++] 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.

[Visual Basic] This method sets the Number property of the global Err object to S_OK (&H00000000) to indicate success and to standard COM 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. In particular, the Description property may contain a text description of the error.

The following table describes the custom COM errors this method can return.

Name	Value	Description
E_CAT_CATMGR_NOT_INITIALIZED	[C++] 0x889800B5 [Visual Basic] &H889800B5	The CatalogManager object has not been initialized. The CatalogManager object should be initialized before calling this method.

E_CAT_CATMGR_NOT_INITIALIZED

[C++] 0x889800B5

[Visual Basic] &H889800B5

The CatalogManager object has not been initialized. The CatalogManager object should be initialized before calling this method.

Remarks

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 unless the fForceRebuild parameter is set to True*.*

[C++] If you want to rebuild a specific virtual catalog or the virtual catalogs that are dependant on a specific base catalog use IProductCatalog3::RebuildVirtualCatalog.

[Visual Basic] If you want to rebuild a specific virtual catalog or the virtual catalogs that are dependant on a specific base catalog use ProductCatalog.RebuildVirtualCatalog.

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