_CatalogSets::RemoveCatalogFromCatalogSets [C++]

Article
11/12/2009

Use this method to remove a catalog from all catalog sets.

Definition

[C++]

HRESULT _CatalogSets::RemoveCatalogFromCatalogSets(BSTRCatalogName);

[Visual Basic]

Sub RemoveCatalogFromCatalogSets(CatalogName As String)

Parameters

CatalogName[C++]
[in] A BSTR that contains the catalog name to be removed.
CatalogName[Visual Basic]
A String that contains the catalog name to be removed.

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.

Remarks

This method should be called whenever a catalog is deleted, before or after calling the CatalogManager.DeleteCatalog or ProductCatalog.DeleteCustomCatalog methods.

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