SearchServiceApplicationProxy.GetDisplayGroupIDFromName method

Article
05/27/2015

Retrieves the ID of a Search scope display group with the specified Search name that is managed by the specified Search scope consumer.

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 SearchServiceApplicationProxy
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.

name
Type: System.String

The name of the ScopeDisplayGroup object.

Return value

Type: System.Int32
The ID of the Search ScopeDisplayGroup object, or null if the Search scope display group does not exist.

Implements

ISearchSiteAdministrationServiceApplication.GetDisplayGroupIDFromName(String, String)

Exceptions

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

Remarks

The value of the consumerName parameter must not be null .

The value of the name parameter must not be null .