FILTER()

Purpose

Function to return filter expression

Syntax

FILTER([<workarea | alias>])

See Also

DBFILTER(), ISFILTERED(), SET DELETED, SET FILTER

Description

The FILTER() function returns the current filter condition as a string. If no filter is set, the FILTER() function returns a null string. If the optional <workarea | alias> is specified, then the function will return the active filter condition for the specified <workarea | alias>. Filters are set for a workarea using the SET FILTER command. The FILTER() has no effect on the SET FILTER command.

Example

use patrons
set filter to event="BALLET"
? "["+filter()+"]"
[event="BALLET"]
? type("filter()")
C