IProductCatalog3::Purge Method [C++]

Article
11/12/2009

Use this method to remove deleted products, categories, and variants from the catalog.

Definition

[C++]

HRESULT IProductCatalog3::Purge();

[Visual Basic]

Sub Purge()

Parameters

[C++] None.

[Visual Basic] None.

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.

In addition to standard COM errors, purge may return ADO errors.

Remarks

Commerce Server 2002 uses a two-stage delete process. When items are deleted from a catalog they are not removed from the Product Catalog System. The product rows are moved from the catalog tables to a deleted products table. This allows deletions to be exported with other changes using the DeltaExportXML method. Use the Purge method to remove the marked products from the database. The Purge method is not accessible through the user interface.

Ee797932.caution(en-US,CS.20).gif Caution

There is no method for recovering deleted products.

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