Share via


CatalogConnectionManager.GetCatalogConnectionSettings method

Gets the settings for a catalog that is connected to this site.

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

Syntax

'Declaration
Public Function GetCatalogConnectionSettings ( _
    catalogPath As String _
) As CatalogConnectionSettings
'Usage
Dim instance As CatalogConnectionManager
Dim catalogPath As String
Dim returnValue As CatalogConnectionSettings

returnValue = instance.GetCatalogConnectionSettings(catalogPath)
public CatalogConnectionSettings GetCatalogConnectionSettings(
    string catalogPath
)

Parameters

  • catalogPath
    Type: System.String

    URL that identifies the catalog as the URL is stored in the search index. If the catalog is a SPList object, then this URL is the absolute URL.

Return value

Type: Microsoft.SharePoint.Publishing.CatalogConnectionSettings
Configured settings for the connection.

Remarks

This method requires case-sensitive URLs.

See also

Reference

CatalogConnectionManager class

CatalogConnectionManager members

Microsoft.SharePoint.Publishing namespace

Microsoft.SharePoint.Publishing.CatalogConnectionSettings