Difference between revisions of "RemoveFilter"

From Catglobe Wiki
Jump to: navigation, search
(jrfconvert import)
 
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Category:HelpBooks]]
+
[[Category:Data_Cache_Functions]]

+
{{HelpFiles}}
  
=====removeFilter=====
+
====removeFilter====
  
Removes the filter with the given id.
+
Remove a filter expression from filter expression list.
  
 
'''Syntax'''
 
'''Syntax'''
  
removeFilter(''filterId'')
+
removeFilter(''filterIndex'')
  
 
'''Arguments'''
 
'''Arguments'''
  
''filterID:'' Is a numeric expression. It is the id of the filter returned by addFilter function when the filter was added. Error message will be shown when the id is invalid.
+
''filterIndex''Is a numeric (non-decimal) expression.
  
 
'''Return type'''
 
'''Return type'''
Line 20: Line 20:
 
'''Examples'''
 
'''Examples'''
  
removeFilter(1);//remove the first filter added
+
''addFilter("Sex == 1"); ''
 +
 
 +
''addFilter("Age == 18"); ''
 +
 
 +
''string a = dcGetFilterExpression(); ''
 +
 
 +
''print(a); //(Sex == 1) && (Age == 18) ''
 +
 
 +
''removeFilter(1); ''
 +
 
 +
''a = dcGetFilterExpression(); ''
 +
 
 +
''print(a); //(Age == 18) ''
  
 
'''Availability'''
 
'''Availability'''
  
Version 5.5
+
Version 5.4
 
__NOTOC__
 
__NOTOC__
<!-- imported from file: 5206.htm-->
+
<!-- imported from file: 4249.htm-->

Latest revision as of 10:21, 20 December 2011



removeFilter

Remove a filter expression from filter expression list.

Syntax

removeFilter(filterIndex)

Arguments

filterIndex: Is a numeric (non-decimal) expression.

Return type

empty

Examples

addFilter("Sex == 1");

addFilter("Age == 18");

string a = dcGetFilterExpression();

print(a); //(Sex == 1) && (Age == 18)

removeFilter(1);

a = dcGetFilterExpression();

print(a); //(Age == 18)

Availability

Version 5.4