SearchServiceApplicationProxy.GetConsumerInformation method

  • Article

Gets the Search scope consumer information with the specified consumer name.

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

Syntax

'Declaration
Public Function GetConsumerInformation ( _
    consumerName As String _
) As ConsumerInfo
'Usage
Dim instance As SearchServiceApplicationProxy
Dim consumerName As String
Dim returnValue As ConsumerInfo

returnValue = instance.GetConsumerInformation(consumerName)

public ConsumerInfo GetConsumerInformation(
    string consumerName
)

Parameters

  • consumerName
    Type: System.String

    The name of the Search scope consumer.

Return value

Type: Microsoft.Office.Server.Search.Administration.ConsumerInfo
Information about the Search scope consumer.

Implements

ISearchSiteAdministrationServiceApplication.GetConsumerInformation(String)

Exceptions

Exception Condition
Exception

An error, such as a SearchServiceApplicationFault, occurred during application execution.

Remarks

This method returns the Search scopes, Search scope display groups, and membership information of the specified Search scope consumer.

See also

Reference

SearchServiceApplicationProxy class

SearchServiceApplicationProxy members

Microsoft.Office.Server.Search.Administration namespace