SearchServiceApplicationProxy.AddConsumer Method

Article
07/24/2014

Adds a Search scope consumer to the Search administration database.

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

Syntax

'Declaration
Public Function AddConsumer ( _
    consumerName As String _
) As Integer
'Usage
Dim instance As SearchServiceApplicationProxy
Dim consumerName As String
Dim returnValue As Integer

returnValue = instance.AddConsumer(consumerName)

public int AddConsumer(
    string consumerName
)

Parameters

consumerName
Type: System.String

The name that uniquely identifies the Search scope consumer.

Return Value

Type: System.Int32
0 indicates successful execution; 1 indicates that the Search scope consumer already exists.

Implements

ISearchSiteAdministrationServiceApplication.AddConsumer(String)

Exceptions

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

Remarks

This method adds the Search scope consumer specified by the consumerName parameter to the Search administration database.