<Source>.ActivateFilter (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Enabling and disabling a filter

Number of possible active filters

Operating mode in OLE DB

ErrorStatusModification

FilterIncludedBetween

MigrateLinkedCompositeKey

Enabling and disabling a filter
Number of possible active filters
Operating mode in OLE DB

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

<Source>.ActivateFilter (Function)

In french: <Source>.ActiveFiltre

Not available with this kind of connection

Enables the filter that was previously created for the specified data file (view or query). This filter was created by <Source>.Filter and disabled by <Source>.DeactivateFilter. <Source>.ActivateFilter has no effect if no filter was declared.

This function can be used with the data files, HFSQL views or queries.

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>.ActivateFilter()

<Result>: Boolean

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

<Source>: Type corresponding to the specified source

Name of data file, HFSQL view or query used.

Remarks

Enabling and disabling a filter

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

Number of possible active filters

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

Operating mode in OLE DB

If <Source>.ActivateFilter is used when browsing a data file, the browse is stopped. To take the filter into account, you must restart browsing with <Source>.ReadFirst/<Source>.First or <Source>.ReadLast/<Source>.Last.

The current position and all the stored positions are lost. The position will be restored according to the value of best item.

Component: wd260hf.dll