CatalogManager3.DeleteCatalog Method (PIA)

  • Article

Use this method to delete a catalog and derived custom catalogs from the Product Catalog System.

Definition

[Visual Basic .NET]

Imports Microsoft.CommerceServer.Interop.Catalog
…
Public Sub DeleteCatalog(strCatalogName As String)

[C#]

using Microsoft.CommerceServer.Interop.Catalog;
…
public void DeleteCatalog(stringstrCatalogName);

Parameters

[Visual Basic .NET]

  • strCatalogName
    A String that contains the name of the catalog to be deleted.

[C#]

  • strCatalogName
    A string that contains the name of the catalog to be deleted.

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 a COMException can wrap.

Constant Value Description
E_CAT_CATMGR_NOT_INITIALIZED

[C#] 0x889800B5

[Visual Basic .NET] &H889800B5

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

[C#] 0x88980063

[Visual Basic .NET] &H88980063

 The Catalog Name you specified is invalid. Catalog names cannot be blank
E_CAT_INVALID_CATALOG_NAME_LENGTH

[C#] 0x88980042

[Visual Basic .NET] &H88980042

 The Catalog name you specified exceeds the maximum limit of 85 characters.
E_CAT_CHARACTER_NOT_ALLOWED

[C#] 0x8898003D

[Visual Basic .NET] &H8898003D

 The catalog name you specified has one of the nine reserved characters:
" [ ] , ' ( )#.

You should not use these reserved characters.
E_CAT_CATALOG_EXPORT_IN_PROGRESS

[C#] 0x88980058

[Visual Basic .NET] &H88980058

 The catalog you specified is currently being exported or imported. This catalog or its associated languages cannot be deleted.

Remarks

This method cannot be called in a transacted object. This method involves the creation, deletion, or updating of free text indexes. SQL Server does not allow these operations in a transaction.

Deleting a catalog will also delete any custom catalogs that were derived from it.

[Visual Basic .NET]

Example

myCatalogManager.DeleteCatalog("OurStore")

Requirements

Namespace: Microsoft.CommerceServer.Interop.Catalog

Platforms: Windows 2000, Windows Server 2003

Assembly: cataloglib (in cataloglib.dll)

See Also

CatalogManager3 Class

CatalogManager3.CreateCatalog

Copyright © 2005 Microsoft Corporation.
All rights reserved.