PublishingCatalogUtility.GetPublishingCatalogs method

Retrieves shared catalogs that are available for subscription.

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

Syntax

'Declaration
Public Shared Function GetPublishingCatalogs ( _
    site As SPSite, _
    startRow As Integer, _
    numberOfRows As Integer, _
    filterText As String, _
    <OutAttribute> ByRef totalNumberOfCatalogs As Integer _
) As List(Of CatalogConnectionSettings)
'Usage
Dim site As SPSite
Dim startRow As Integer
Dim numberOfRows As Integer
Dim filterText As String
Dim totalNumberOfCatalogs As Integer
Dim returnValue As List(Of CatalogConnectionSettings)

returnValue = PublishingCatalogUtility.GetPublishingCatalogs(site, _
    startRow, numberOfRows, filterText, _
    totalNumberOfCatalogs)

public static List<CatalogConnectionSettings> GetPublishingCatalogs(
    SPSite site,
    int startRow,
    int numberOfRows,
    string filterText,
    out int totalNumberOfCatalogs
)

Parameters

• site
  Type: Microsoft.SharePoint.SPSite

  The site collection that is requesting shared catalog information from search.

• startRow
  Type: System.Int32

  The start location in the search results. This parameter is used for paging.

• numberOfRows
  Type: System.Int32

  The total number of search results that are available from the search index.

• filterText
  Type: System.String

  Additional keywords to filter the shared catalogs that are returned.

• totalNumberOfCatalogs
  Type: System.Int32

  Total number of search results that are available from the search index.

Return value

Type: System.Collections.Generic.List<CatalogConnectionSettings>
Information about shared catalogs.

See also

Reference

PublishingCatalogUtility class

PublishingCatalogUtility members

Microsoft.SharePoint.Publishing namespace