SearchServiceApplicationProxy.GetUnusedScopesForConsumer method

Retrieves the information about all Search scopes owned by the specified Search scope consumer that are not associated with any Search scope display group

Namespace:  Microsoft.Office.Server.Search.Administration
Assembly:  Microsoft.Office.Server.Search (in Microsoft.Office.Server.Search.dll)

Syntax

'Declaration
Public Function GetUnusedScopesForConsumer ( _
    consumerName As String _
) As List(Of ScopeInfo)
'Usage
Dim instance As SearchServiceApplicationProxy
Dim consumerName As String
Dim returnValue As List(Of ScopeInfo)

returnValue = instance.GetUnusedScopesForConsumer(consumerName)
public List<ScopeInfo> GetUnusedScopesForConsumer(
    string consumerName
)

Parameters

  • consumerName
    Type: System.String

    The name of the Search scope consumer.

Return value

Type: System.Collections.Generic.List<ScopeInfo>
The list of information about all Search scopes.

Implements

ISearchSiteAdministrationServiceApplication.GetUnusedScopesForConsumer(String)

Exceptions

Exception Condition
Exception

An error occurred during application execution.

Remarks

The value of the consumerName parameter must not be null .

See also

Reference

SearchServiceApplicationProxy class

SearchServiceApplicationProxy members

Microsoft.Office.Server.Search.Administration namespace