Difference between revisions of "FILTER()"

From Recital Documentation Wiki
Jump to: navigation, search
(Class)
 
Line 1: Line 1:
 
 
 
==Purpose==
 
==Purpose==
 
Function to return filter expression
 
Function to return filter expression
Line 29: Line 27:
  
 
==Products==
 
==Products==
Recital Database Server, Recital Mirage Server, Recital Terminal Developer
+
Recital Server, Recital  
 
[[Category:Documentation]]
 
[[Category:Documentation]]
 
[[Category:Functions]]
 
[[Category:Functions]]

Latest revision as of 17:34, 27 November 2009

Purpose

Function to return filter expression


Syntax

FILTER([<workarea | alias>])


See Also

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


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


Products

Recital Server, Recital