Difference between revisions of "FILTER()"

From Lianjapedia
Jump to: navigation, search
 
 
(2 intermediate revisions by one other user not shown)
Line 1: Line 1:
 
==Purpose==
 
==Purpose==
 
Function to return filter expression
 
Function to return filter expression
 
  
 
==Syntax==
 
==Syntax==
 
FILTER([<workarea | alias>])
 
FILTER([<workarea | alias>])
 
  
 
==See Also==
 
==See Also==
[[DBFILTER()]], [[ISFILTERED()]], [[SET DELETED]], [[SET FILTER]], [[SET VIEW]]
+
[[DBFILTER()]], [[ISFILTERED()]], [[SET DELETED]], [[SET FILTER]]
 
+
  
 
==Description==
 
==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.
 
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==
 
==Example==
Line 25: Line 21:
 
</code>
 
</code>
  
 
==Products==
 
Recital Server, Recital
 
 
[[Category:Documentation]]
 
[[Category:Documentation]]
 
[[Category:Functions]]
 
[[Category:Functions]]
 +
[[Category:Cursor Functions]]

Latest revision as of 04:51, 7 December 2012

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