SearchServiceApplicationProxy.AddConsumer method

  • Article

Adds a scope consumer to the SearchAdminDatabase. Applies to: Microsoft SharePoint Server 2010 search

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
The execution result.
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 a search scope consumer to the SearchAdminDatabase.

See also

Reference

SearchServiceApplicationProxy class

SearchServiceApplicationProxy members

Microsoft.Office.Server.Search.Administration namespace