Difference between revisions of "DBFILTER()"

From Lianjapedia
Jump to: navigation, search
m (1 revision)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
 
==Purpose==
 
==Purpose==
 
Function to return the filter expression
 
Function to return the filter expression
 
  
 
==Syntax==
 
==Syntax==
 
DBFILTER([<workarea | alias>])
 
DBFILTER([<workarea | alias>])
 
  
 
==See Also==
 
==See Also==
[[FILTER()]], [[SET DELETED]], [[SET FILTER]], [[SET VIEW]]
+
[[FILTER()]], [[SET DELETED]], [[SET FILTER]]
 
+
  
 
==Description==
 
==Description==
 
The DBFILTER() function will return, as a character string, the current filter condition or a null string if no filter is set.  If the <workarea | alias> is specified, then the function will return the active filter condition for the specified alias.  The command SET FILTER ON | OFF has no affect on the DBFILTER() function.
 
The DBFILTER() function will return, as a character string, the current filter condition or a null string if no filter is set.  If the <workarea | alias> is specified, then the function will return the active filter condition for the specified alias.  The command SET FILTER ON | OFF has no affect on the DBFILTER() function.
 
  
 
==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:52, 7 December 2012

Purpose

Function to return the filter expression

Syntax

DBFILTER([<workarea | alias>])

See Also

FILTER(), SET DELETED, SET FILTER

Description

The DBFILTER() function will return, as a character string, the current filter condition or a null string if no filter is set. If the <workarea | alias> is specified, then the function will return the active filter condition for the specified alias. The command SET FILTER ON | OFF has no affect on the DBFILTER() function.

Example

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