PublishingCatalogUtility.GetCatalogConfiguration method

Gets catalog configuration information for a shared publishing catalog.

Namespace:  Microsoft.SharePoint.Publishing
Assembly:  Microsoft.SharePoint.Publishing (in Microsoft.SharePoint.Publishing.dll)

Syntax

'Declaration
Public Shared Function GetCatalogConfiguration ( _
    list As SPList, _
    <OutAttribute> ByRef catalogSettings As CatalogShareSettings, _
    <OutAttribute> ByRef selectedTaxonomyField As String _
) As Boolean
'Usage
Dim list As SPList
Dim catalogSettings As CatalogShareSettings
Dim selectedTaxonomyField As String
Dim returnValue As Boolean

returnValue = PublishingCatalogUtility.GetCatalogConfiguration(list, _
    catalogSettings, selectedTaxonomyField)

public static bool GetCatalogConfiguration(
    SPList list,
    out CatalogShareSettings catalogSettings,
    out string selectedTaxonomyField
)

Parameters

• list
  Type: Microsoft.SharePoint.SPList

  The SPList object for which configuration information is returned.

• catalogSettings
  Type: Microsoft.SharePoint.Publishing.CatalogShareSettings

  Configuration information for the shared publishing catalog.

• selectedTaxonomyField
  Type: System.String

  Managed property name from the search schema of the default taxonomy field in the shared catalog. The Term categories in this field can be used by a catalog subscriber to determine the navigation hierarchy that represents this catalog at a subscribing site.

Return value

Type: System.Boolean
true if this list is a shared catalog; otherwise, false

See also

Reference

PublishingCatalogUtility class

PublishingCatalogUtility members

Microsoft.SharePoint.Publishing namespace

Microsoft.SharePoint.Publishing.CatalogShareSettings

CatalogConnectionManager.AddCatalogConnection