SearchServiceApplicationProxy.GetRulesCount method

Article
05/27/2015

Retrieves the number of Search scope rules for 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 GetRulesCount ( _
    scopeId As Integer, _
    <OutAttribute> ByRef statusCode As Integer _
) As Integer
'Usage
Dim instance As SearchServiceApplicationProxy
Dim scopeId As Integer
Dim statusCode As Integer
Dim returnValue As Integer

returnValue = instance.GetRulesCount(scopeId, _
    statusCode)

public int GetRulesCount(
    int scopeId,
    out int statusCode
)

Parameters

scopeId
Type: System.Int32

The ID of the Search Scope object containing Search scope rules.

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.Int32
The number of Search ScopeRule objects in the Search scope.

Implements

ISearchSiteAdministrationServiceApplication.GetRulesCount(Int32, 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 value of the scopeId parameter must not be null .