setFilter

Function: setFilter()

Applies a script-based Filter Condition to a Pipe, causing a lookup to be performed on the Pipe. Once the lookup is completed the filter is cleared.

setFilter() will return the result of the Pipe lookup.

Note that any filter conditions configured directly on the Pipe will be ignored.

Syntax

setFilter(pipeName, filterName)

ArgumentTypeDescription
pipeNameStringThe name of the Pipe for which to apply the Filter.
filterNameStringThe name of the Filter to be applied to the Pipe.

Examples

setFilter(telephoneCalls, callFilter)

Sets the Filter called callFilter on the Pipe called telephoneCalls.

See Also