<Source>.DeactivateFilter (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Enabling and disabling a filter

Number of possible active filters

ErrorStatusModification

FilterIncludedBetween

MigrateLinkedCompositeKey

New WINDEV, WEBDEV, WINDEV Mobile 25 feature!

Enabling and disabling a filter
Number of possible active filters
Browse

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<Source>.DeactivateFilter (Function)

In french: <Source>.DésactiveFiltre

Not available with this kind of connection

Temporarily disables the filter on a data file (view or query). This filter was created by <Source>.Filter. <Source>.DeactivateFilter has no effect if no filter was declared.

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

Example

// Declare the filter: select customers
// between 20 and 60 years old
Customer.Filter(AGE_Customer, 20, 60)
...
Customer.DeactivateFilter() // Disabled filter
...
// Browse the data file with a filter on age
// Process the customers who are between 20 and 60 years old
// (ProcessCustomer2060 procedure)
Customer.ActivateFilter()
Customer.ReadFirst(AGE_Customer)
WHILE Customer.Found() = True
ProcessCustomer2060()
Customer.ReadNext(AGE_Customer)
END

Syntax

<Result> = <Source>.DeactivateFilter()

<Result>: Boolean

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

<Source>: Type corresponding to the specified source

Name of data file, view or query used.

Remarks

Enabling and disabling a filter

The filter is enabled once it has been declared (<Source>.Filter). A filter disabled by <Source>.DeactivateFilter can be re-enabled by <Source>.ActivateFilter.

Remark: During the call to <Source>.Close, 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 <Source>.Filter and <Source>.DeactivateFilter are taken into account when using <Source>.ReadFirst/<Source>.First, <Source>.ReadLast/<Source>.Last or <Source>.ReadSeekFirst/<Source>.ReadSeekLast.

Component : wd250hf.dll