SearchServiceApplicationProxy.GetRulesInfo method

Article
05/27/2015

Retrieves the information about all the scope rules defined within the specified Search scope.

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

Syntax

'Declaration
Public Function GetRulesInfo ( _
    scopeId As Integer, _
    <OutAttribute> ByRef statusCode As Integer _
) As List(Of RuleInfo)
'Usage
Dim instance As SearchServiceApplicationProxy
Dim scopeId As Integer
Dim statusCode As Integer
Dim returnValue As List(Of RuleInfo)

returnValue = instance.GetRulesInfo(scopeId, _
    statusCode)

public List<RuleInfo> GetRulesInfo(
    int scopeId,
    out int statusCode
)

Parameters

scopeId
Type: System.Int32

The ID of the Search scope.

statusCode
Type: System.Int32

When this method returns, it contains a number that represents the status code of method execution, where 0 indicates successful execution, and 1 indicates that the Search scope with the specified ID was not found. This parameter is passed uninitialized.

Return value

Type: System.Collections.Generic.List<RuleInfo>
The list of information about all the scope rules

Implements

ISearchSiteAdministrationServiceApplication.GetRulesInfo(Int32, Int32)

Exceptions

Exception	Condition
TimeoutException	The time allotted for the operation has expired.
EndpointNotFoundException	The remote endpoint could not be found or reached.
Exception	An error occurred during application execution.

Remarks

The value of the scopeId parameter must not be null .