SphinxSearchOptionsSetFilterTFilterable Method (String, IEnumerableTFilterable, Boolean)

Sets a filter for the attribute with the given name.

Namespace: SphinxConnector.NativeApi
Assembly: SphinxConnector (in SphinxConnector.dll) Version: 5.3.0

Syntax

public void SetFilter<TFilterable>(
	string attributeName,
	IEnumerable<TFilterable> values,
	bool exclude
)
where TFilterable : IFilterableType

Public Sub SetFilter(Of TFilterable As IFilterableType) ( 
	attributeName As String,
	values As IEnumerable(Of TFilterable),
	exclude As Boolean
)

attributeName: Type: SystemString
The name of the attribute to filter on.
values: Type: System.Collections.GenericIEnumerableTFilterable
The value for the filter.
exclude: Type: SystemBoolean
if set to true excludes the matching documents from the result.

Exceptions

Exception	Condition
ArgumentNullException	attributeName or values is null.
ArgumentException	attributeName is empty or values contains more than one value for a string filter.
NotSupportedException	Attributes of type TFilterable are not supported in Version.

Remarks

Please note that JSON string filters can currently only contain one value.