ResultTableCollection.Filter method (String, String, Object)

  • Article

Filters from the ResultTableCollection ResultTables that have a property equal to a value and QueryId equal to queryId. Orders the returned ResultTables by ResultTable.Order.

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

Syntax

'Declaration
Public Function Filter ( _
    queryId As String, _
    propertyName As String, _
    value As Object _
) As IEnumerable(Of ResultTable)
'Usage
Dim instance As ResultTableCollection
Dim queryId As String
Dim propertyName As String
Dim value As Object
Dim returnValue As IEnumerable(Of ResultTable)

returnValue = instance.Filter(queryId, _
    propertyName, value)

public IEnumerable<ResultTable> Filter(
    string queryId,
    string propertyName,
    Object value
)

Parameters

  • queryId
    Type: System.String

    The Id of the query for which you want the filtering to applied.

  • propertyName
    Type: System.String

    The name of the property in ResultTable to which the filtering will be applied.

  • value
    Type: System.Object

    The value the specified property must have, for the ResultTable to be included in the filtered set

Return value

Type: System.Collections.Generic.IEnumerable<ResultTable>
an IEnumerable of all the Tables that match the filter condition, ordered by ResultTable.Order

Remarks

The relative ordering of ResultTables returned by this fucntion that have the same calue for the Order property is undefined. ResultTables that do not have a property with name given by propertyName will not be returned.

Examples

You might do: resultTableCollection.Filter("RowCount",0) to get a IEnumerable for the empty ResultTables that are part of the ResultTableCollection.

See also

Reference

ResultTableCollection class

ResultTableCollection members

Filter overload

Microsoft.Office.Server.Search.Query namespace