SearchServiceApplication.GetDisplayGroupIDFromName Method

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

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

Syntax

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

returnValue = instance.GetDisplayGroupIDFromName(consumerName, _
    name)

public int GetDisplayGroupIDFromName(
    string consumerName,
    string name
)

Parameters

• consumerName
  Type: System.String

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

• name
  Type: System.String

  The name of the SearchScopeDisplayGroup.

Return Value

Type: System.Int32
The ID of the SearchScopeDisplayGroup.

Implements

ISearchSiteAdministrationServiceApplication.GetDisplayGroupIDFromName(String, String)

Remarks

This return value will be set to null if the SearchScopeDisplayGroup does not exist.

The value of the consumerName parameter must not be null .

The value of the name parameter must not be null .

See Also

Reference

SearchServiceApplication Class

SearchServiceApplication Members

Microsoft.Office.Server.Search.Administration Namespace