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

Example

// Déclaration du filtre : sélection des clients
// qui ont entre 20 et 60 ans
Client.Filtre(Age_Client, 20, 60)
...
Client.DésactiveFiltre() // Filtre désactivé
...
// Parcours du fichier de données avec filtre sur l'âge
// Traitement des clients qui ont entre 20 et 60 ans
// (procédure TraiteClient2060)
Client.ActiveFiltre()
Client.LitPremier(Age_Client)
WHILE Client.Trouve() = True
	TraiteClient2060()
	Client.LitSuivant(Age_Client)
END

Syntax

<Result> = <Source>.ActivateFilter()

<Result>: Boolean

True if the filter is enabled,
False if an error occurred (data 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 navigating through a data file, the navigation is stopped. To take the filter into account, you must navigate through the data file again 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: wd300hf.dll