HDeactivateFilter (Function)

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.

Versions 15 and later

This function is now available for Android applications.

New in version 15

This function is now available for Android applications.

Versions 17 and later

This function is now available for iPhone/iPad applications.

New in version 17

This function is now available for iPhone/iPad applications.

Versions 18 and later

This function is now available in Android Widget mode.

This function is now available in Windows Store apps mode.

New in version 18

This function is now available in Android Widget mode.

This function is now available in Windows Store apps mode.

This function is now available in Android Widget mode.

This function is now available in Windows Store apps mode.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Universal Windows 10 App mode.

Note: From version 19, HFSQL is the new name of HyperFileSQL.

Example

See additional examples

// Declare the filter: selecting the customers
// who are between 20 and 60 years old
HFilter(CUSTOMER, AGE_Customer, 20, 60)
...
HDeactivateFilter(CUSTOMER) // Disabled filter
...
// Browse the file with a filter on the 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([<File name>])

<Result>: Boolean

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

<File name>: Optional character string (with or without quotes)

Name of data file, view or query used. If this parameter is not specified, HDeactivateFilter handles the last data file used by the last function for HFSQL management (starting with the letter 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: During the call to HClose, the filter enabled by HFilter is automatically deleted.

Number of possible active filters

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

Browse

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

Component : wd240hf.dll