Click or drag to resize

DbClearFilter Function (Usual)

X#
Clear a logical filter condition.

Namespace:  XSharp.RT
Assembly:  XSharp.RT (in XSharp.RT.dll) Version: 2.19
Syntax
Copy
 FUNCTION DbClearFilter(
	uArea AS USUAL
) AS LOGIC
Request Example View Source

Parameters

uArea
Type: Usual
Specifies the work area name or number for a table from which the value must be retrieved.

Return Value

Type: Logic
TRUE if successful; otherwise, FALSE.
Remarks
DBClearFilter() performs the same function as the SET FILTER command with no expression specified.
For more information, refer to SET FILTER.
By default, this function operates on the currently selected work area.
It can be made to operate on an unselected work area by specifying it within an aliased expression or by calling the overload that accepts a workarea parameter (a workarea number or alias ).
Tip Tip
Logical records: DBClearFilter() affects the logical visibility of records in a work area.
For more information, refer to DBSetFilter() and the SET FILTER command.
Examples
The following example sets a filter, lists data as filtered, and then clears the filter:
X#
Copy
1USE employee NEW
2DBSetFilter({|| Age < 40}, "Age < 40")
3GO TOP
4LIST Employee->Name
5DBClearFilter()
See Also