SearchServiceApplicationProxy.GetScopeIDFromName Method

Retrieves the ID of a Search scope with the specified name and Search scope consumer.

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

Syntax

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

returnValue = instance.GetScopeIDFromName(consumerName, _
    name)

public int GetScopeIDFromName(
    string consumerName,
    string name
)

Parameters

• consumerName
  Type: System.String

  The name of the Search scope consumer that manages the Search scope.

• name
  Type: System.String

  The name of the Search scope.

Return Value

Type: System.Int32
The ID of the Search scope.

Implements

ISearchSiteAdministrationServiceApplication.GetScopeIDFromName(String, String)

Exceptions

Exception	Condition
Exception	An error occurred during application execution.

Remarks

The values of the consumerName and name parameters must not be null .

See Also

Reference

SearchServiceApplicationProxy Class

SearchServiceApplicationProxy Members

Microsoft.Office.Server.Search.Administration Namespace