HDeactivateFilter (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Help / WLanguage / Managing databases / HFSQL / HFSQL functions

Enabling and disabling a filter
Number of possible active filters
Browse

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

HDeactivateFilter (Function)

In french: HDésactiveFiltre

Not available with this kind of connection

Temporarily disables the filter on a data file (view or query). This filter was created by HFilter. HDeactivateFilter has no effect if no filter was declared.

Example

See additional examples

// Filter declaration: customer selection
// between 20 and 60 years old
HFilter(Customer, Age_Customer, 20, 60)
...
HDeactivateFilter(Customer) // Disabled filter
...
// Browse the data file with a filter on age
// Process the customers who are between 20 and 60 years old
// (ProcessCustomer2060 procedure)
HActivateFilter(Customer)
HReadFirst(Customer, Age_Customer)
WHILE HFound(Customer) = True
	ProcessCustomer2060()
	HReadNext(Customer, Age_Customer)
END

Syntax

<Result> = HDeactivateFilter([<Data file>])

<Result>: Boolean

True if the filter is disabled,
False if an error occurred (data file or item not found).

<Data file>: Optional character string

Name of the data file, view or query used.
If this parameter is not specified, HDeactivateFilter handles the last data file used by the last HFSQL management function (function starting with "H").

Remarks

Enabling and disabling a filter

The filter is enabled once it has been declared (HFilter). A filter disabled by HDeactivateFilter can be re-enabled by HActivateFilter.

Note: When calling function HClose, the filter activated by function HFilter function is automatically deleted.

Number of possible active filters

A single filter can be enabled at a time for a specific data file.

Browse

The modifications performed by HFilter and HDeactivateFilter are taken into account when using HReadFirst/HFirst, HReadLast/HLast or HReadSeekFirst/HReadSeekLast.

Component: wd300hf.dll