SearchServiceApplicationProxy.AddDisplayGroup Method

Article
07/24/2014

Adds a Search scope display group for a Search scope consumer.

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

Syntax

'Declaration
Public Function AddDisplayGroup ( _
    displayGroupInfo As DisplayGroupInfo, _
    <OutAttribute> ByRef statusCode As Integer _
) As Integer
'Usage
Dim instance As SearchServiceApplicationProxy
Dim displayGroupInfo As DisplayGroupInfo
Dim statusCode As Integer
Dim returnValue As Integer

returnValue = instance.AddDisplayGroup(displayGroupInfo, _
    statusCode)

public int AddDisplayGroup(
    DisplayGroupInfo displayGroupInfo,
    out int statusCode
)

Parameters

displayGroupInfo
Type: Microsoft.Office.Server.Search.Administration.DisplayGroupInfo

Information about the Search scope display group.

statusCode
Type: System.Int32

When this method returns, contains a number that represents the execution status. This parameter is passed uninitialized.

Return Value

Type: System.Int32
The execution result.

Implements

ISearchSiteAdministrationServiceApplication.AddDisplayGroup(DisplayGroupInfo, Int32)

Exceptions

Exception	Condition
TimeoutException	The time-out for an operation has expired.
EndpointNotFoundException	The remote endpoint could not be found or reached.
Exception	An error, such as a SearchServiceApplicationFault, occurred during application execution.

Remarks

This method returns the ID of the new Search scope display group if the execution is successful; otherwise, this method returns -1.

Share via