PC SOFT

DOCUMENTATION EN LIGNE
DE WINDEV, WEBDEV ET WINDEV MOBILE

  • Recherche générique / Recherche à l'identique
  • Recherche sur une rubrique clé ou non clé
  • Recherche sur une clé composée
  • Recherche sur une rubrique tableau
  • Recherche et filtre
  • Parcours des enregistrements correspondant à une condition
  • Recherche à l'identique sous Access
  • Blocages
  • Optimisation du temps de parcours
  • Accès Natif XML
Produits
WinDevWebDev - Code ServeurWebDev - Code NavigateurWinDev MobileEtats et Requêtes
Plateformes
WindowsLinuxWindows MobileUniversal Windows 10 AppAndroidWidget AndroidiPhone/iPadApple Watch
Langages
JavaPHPAjaxCode Utilisateur (MCU)Langage Externe
Bases de données
HFSQLHFSQL Client/ServeurProcédures stockéesOLE DBODBCAccès Natifs
Positionne sur le premier enregistrement du fichier de données dont la valeur d'une rubrique spécifique est strictement égale à une valeur recherchée (recherche à l'identique). L'enregistrement est lu et les variables HFSQL correspondantes sont mises à jour.
En général, la fonction HLitRecherchePremier permet de se positionner dans le fichier de données pour effectuer une boucle de parcours parmi les enregistrements correspondant à une condition. La fonction HLitSuivant permet de lire l'enregistrement suivant correspondant à la condition.
Après l'exécution de la fonction HLitRecherchePremier, plusieurs cas peuvent se présenter :
  • un enregistrement correspondant à la condition a été trouvé, bloqué (si nécessaire) et chargé en mémoire : la fonction HTrouve renvoie Vrai.
  • s'il n'existe pas d'enregistrement correspondant à la condition mais s'il existe un enregistrement de valeur supérieure : l'enregistrement est lu, la fonction HEnDehors renvoie Faux et la fonction HTrouve renvoie Faux.
  • le fichier de données est vide : aucune lecture n'est effectuée, la fonction HEnDehors renvoie Vrai et la fonction HTrouve renvoie Faux.
  • la fonction tente de bloquer un enregistrement déjà bloqué en lecture : aucune lecture n'est effectuée, la fonction HErreurBlocage renvoie Vrai et la fonction HEnDehors renvoie Vrai.
    Remarque : Par défaut, une gestion automatique des erreurs de blocages et des conflits de modification est effectuée (sauf dans le code des procédures stockées). A tout moment, il est possible de personnaliser ou de débrancher cette gestion automatique des erreurs avec la fonction HSurErreur.
La fonction HLitRecherchePremier peut être utilisée indifféremment avec les fichiers de données, les vues HFSQL ou les requêtes.
Remarque : la recherche peut être annulée grâce à la fonction HAnnuleRecherche.
Windows MobileJavaPHP Cas particulier : gestion des blocages :
  • Windows Mobile En Mobile, la gestion des blocages est réalisée uniquement sur les fichiers de données HFSQL Client/Serveur ou manipulés par un accès natif. Il n'est pas possible de bloquer un enregistrement HFSQL Mobile. En effet, le système d'exploitation du Pocket PC ne permet pas de bloquer des enregistrements.
  • PHP En PHP, la gestion des blocages n'est pas disponible.
  • Java En Java, lors d'un accès par JDBC, la gestion des blocages n'est pas disponible sur les bases de données accédées par JDBC.
Versions 15 et supérieures
WinDev MobileAndroid Cette fonction est désormais disponible pour les applications Android.
Nouveauté 15
WinDev MobileAndroid Cette fonction est désormais disponible pour les applications Android.
WinDev MobileAndroid Cette fonction est désormais disponible pour les applications Android.
Versions 17 et supérieures
WinDev MobileiPhone/iPad Cette fonction est désormais disponible pour les applications iPhone/iPad.
Nouveauté 17
WinDev MobileiPhone/iPad Cette fonction est désormais disponible pour les applications iPhone/iPad.
WinDev MobileiPhone/iPad Cette fonction est désormais disponible pour les applications iPhone/iPad.
Versions 18 et supérieures
WinDev MobileWidget Android Cette fonction est désormais disponible en mode Widget Android.
WinDevWinDev MobileUniversal Windows 10 App Cette fonction est désormais disponible en mode Windows Store apps.
Nouveauté 18
WinDev MobileWidget Android Cette fonction est désormais disponible en mode Widget Android.
WinDevWinDev MobileUniversal Windows 10 App Cette fonction est désormais disponible en mode Windows Store apps.
WinDev MobileWidget Android Cette fonction est désormais disponible en mode Widget Android.
WinDevWinDev MobileUniversal Windows 10 App Cette fonction est désormais disponible en mode Windows Store apps.
Remarque : A partir de la version 19, HFSQL est le nouveau nom de HyperFileSQL.
Versions 21 et supérieures
WinDevWinDev MobileUniversal Windows 10 App Cette fonction est désormais disponible en mode Universal Windows 10 App.
Nouveauté 21
WinDevWinDev MobileUniversal Windows 10 App Cette fonction est désormais disponible en mode Universal Windows 10 App.
WinDevWinDev MobileUniversal Windows 10 App Cette fonction est désormais disponible en mode Universal Windows 10 App.
// Recherche du premier enregistrement pour lequel
// le nom du CLIENT est DUPOND
HLitRecherchePremier(CLIENT, NOM, "DUPOND")
SI HTrouve(CLIENT) = Faux ALORS
        Erreur("Client non trouvé")
        RETOUR
SINON
        // Suite du traitement sur le client DUPOND
FIN
Syntaxe
<Résultat> = HLitRecherchePremier(<Nom du fichier> , <Nom de la rubrique> , <Valeur recherchée> [, <Options>])
<Résultat> : Booléen
  • Vrai si l'enregistrement a été trouvé (correspond à la valeur renvoyée par la fonction HTrouve).
  • Faux en cas de problème. Ce problème peut être dû :
    • soit à un problème de positionnement (fichier de données vide, ...) : la fonction HTrouve renvoie Faux et la fonction HErreur renvoie 0.
    • soit à une erreur : la fonction HErreur renvoie un entier différent de 0. La fonction HErreurInfo permet d'obtenir plus de détails.
<Nom du fichier> : Chaîne de caractères (avec ou sans guillemets)
Nom du fichier de données HFSQL, de la vue ou de la requête manipulé.
<Nom de la rubrique> : Chaîne de caractères (avec ou sans guillemets)
Nom de la rubrique sur laquelle la recherche doit être effectuée. Cette rubrique peut être une clé de parcours ou non.
Hyper File 5.5 La recherche ne peut être effectuée que sur une rubrique clé.
<Valeur recherchée> : Type correspondant à la valeur
Valeur de la rubrique recherchée.
<Options> : Constante ou combinaison de constantes optionnelle
Permet de paramétrer :
  • le mode de blocage de l'enregistrement recherché
  • le type de recherche effectué.
hBlocageLectureEcritureBlocage en lecture/écriture : l'enregistrement en cours de lecture ne pourra ni être lu ni être modifié par une autre application.
Si une requête est manipulée, le mode de blocage est ignoré.
OLE DB Blocage en écriture seulement. Fonctionnement équivalent à la constante hBlocageEcriture.
PHP Cette constante n'est pas disponible.
Java Accès par JDBC : Cette constante n'est pas disponible.
hBlocageEcritureBlocage en écriture : l'enregistrement en cours de lecture pourra être lu par une autre application mais ne pourra pas être modifié par une autre application.
Si une requête est manipulée, le mode de blocage est ignoré.
PHP Cette constante n'est pas disponible.
Java Accès par JDBC : Cette constante n'est pas disponible.
hBlocageNonAucun blocage (même si la fonction HDébutVerrou a été appelée) : l'enregistrement pourra être lu ou modifié par une autre application pendant la lecture.
PHP Cette constante n'est pas disponible.
Java Accès par JDBC : Cette constante n'est pas disponible.
Versions 17 et supérieures
hForwardOnly
Nouveauté 17
hForwardOnly
hForwardOnly
Accès Natifs Constante utilisable uniquement avec les Accès Natifs.
Permet d'accélérer le parcours des données lors d'un parcours simple qui n'utilise pas les fonctionnalités suivantes :
  • Lecture de l'enregistrement précédent.
  • Modification d'un enregistrement.
  • Sauvegarde de position.
Si une de ces fonctionnalités est utilisée, le résultat peut être différent de celui attendu.
Cette constante peut par exemple être utilisée lors d'un parcours permettant de remplir une table mémoire.
hGénériqueRecherche générique (voir Notes)
Par défaut (constante non spécifiée), la recherche effectuée est une recherche à l'identique.
hLimiteParcoursLe parcours s'arrêtera dès que la dernière valeur recherchée sera trouvée ou si aucune valeur ne correspond à la recherche.
L'enregistrement en cours correspondra à ce dernier enregistrement trouvé.
La fonction HTrouve renverra Faux et la fonction HEnDehors renverra Vrai.
Cette constante permet d'optimiser la vitesse de recherche en mode Client/Serveur et sur les bases externes (accédées via OLE DB ou via les Accès Natifs).
hRespecteFiltreLe parcours prendra en compte le filtre mis en place avec la fonction HFiltre, même si la clé de parcours utilisée n'est pas optimisée pour le filtre. Rappel : la fonction HFiltre renvoie la clé de parcours optimisée pour le filtre.
Attention : dans ce cas, sur des fichiers de données de taille importante, des problèmes de performances peuvent survenir.
Hyper File 5.5 Cette variable ne peut pas être utilisée.
Par défaut, le parcours suivant la fonction HLitRecherchePremier ne prend pas en compte le filtre.
hSansRafraichir
OLE DBAccès Natifs La fonction HLitRecherchePremier ne rafraîchit pas le contenu de la table ou de la requête. Dans la mesure du possible, la requête n'est pas ré-exécutée. Toutes les positions sauvegardées sont conservées.
Windows Mobile La gestion des blocages est réalisée uniquement sur les fichiers de données HFSQL Client/Serveur ou manipulés par un accès natif. Il n'est pas possible de bloquer un enregistrement HFSQL Mobile. En effet, le système d'exploitation du Pocket PC ne permet pas de bloquer des enregistrements.
PHP La gestion des blocages n'est pas disponible.
Java Accès par JDBC : La gestion des blocages n'est pas disponible sur les bases de données accédées par JDBC.
OLE DBAccès Natifs Si le provider OLE DB ou l'Accès Natif utilisé ne gère pas les blocages, les options de blocage seront sans effet.
OLE DB Le mode de blocage spécifié avec la fonction HLitRecherchePremier restera effectif lors des appels aux fonctions HLitPrécédent et HLitSuivant.
Pour modifier le mode de blocage, il est nécessaire d'utiliser :
Remarques

Recherche générique / Recherche à l'identique

  • Recherche générique (essentiellement sur les rubriques de type Chaîne de caractères) : Recherche tous les enregistrements commençant par la valeur indiquée.
    Par exemple : Lors d'une recherche générique de la chaîne "Martin" pour la rubrique NOM, tous les enregistrements dont la rubrique Nom commence par "Martin" correspondront à la recherche. Ainsi, l'enregistrement contenant "Martinez" correspondra à la recherche (la fonction HTrouve renvoie Vrai).
    Remarque : Pour compatibilité avec WINDEV 5.5, la recherche générique d'une chaîne vide ("") est équivalente à l'utilisation de la fonction HLitPremier.
  • Recherche à l'identique : Recherche tous les enregistrements correspondant exactement à la valeur indiquée.
    Par exemple : Lors d'une recherche à l'identique sur la chaîne "Martin" pour la rubrique NOM, la fonction HTrouve renvoie Vrai uniquement pour les enregistrements dont la rubrique vaut exactement "Martin".
  • Exemples de recherches effectuées sur le fichier CLIENT trié par nom :
Valeur cherchéeOptionsHLitRecherchePremier positionne sur l'enregistrement.HTrouve renvoieHEnDehors renvoieExplications
Durand1VraiFauxDurand existe.
La fin du fichier de données n'a pas encore été atteinte.
Dupuis1FauxFauxDupuis n'existe pas. Positionnement sur la première valeur supérieure (Durand).
La fin du fichier de données n'a pas encore été atteinte.
DuponhGénérique8VraiFauxDupon n'existe pas mais la recherche est générique et il existe un Dupond (entre autres).
La fin du fichier de données n'a pas encore été atteinte.
DuponL'enregistrement n'a pas été trouvé (pas de déplacement, l'enregistrement en cours ne change pas).FauxFauxDupon n'existe pas.
La fin du fichier de données n'a pas encore été atteinte.
NorbertL'enregistrement n'a pas été trouvé (pas de déplacement, l'enregistrement en cours ne change pas).FauxVraiNorbert n'existe pas.
Positionnement sur la première valeur supérieure (cette valeur n'existe pas) : la fin du fichier de données est donc atteinte.
Pour plus de détails, consultez le tableau récapitulatif Hyper File 5.5 et 7 : Comment sont gérés les espaces dans les recherches ?

Recherche sur une rubrique clé ou non clé

La recherche peut être effectuée sur une rubrique clé ou non.
Si la recherche est effectuée sur une rubrique clé :
  • la recherche est rapide et le résultat est trié.
  • si le parcours est poursuivi avec la fonction HLitSuivant, les enregistrements suivants correspondront aux valeurs supérieures ou égales à la valeur recherchée. Il faut dans ce cas tester la fonction HEnDehors après chaque lecture, pour vérifier si la fin du fichier de données est atteinte.
Si la recherche est effectuée sur une rubrique non clé :
  • la rubrique sélectionnée apparaîtra en rouge sous l'éditeur de code et un warning sera affiché dans le volet "Erreurs de compilation".
    Remarque : La complétion automatique propose uniquement les rubriques clés.
  • si le parcours est poursuivi avec la fonction HLitSuivant, les enregistrements suivants correspondront aux valeurs égales à la valeur recherchée.

Recherche sur une clé composée

Plusieurs méthodes permettent de faire une recherche sur une clé composée :
1. Utilisation d'une liste de valeurs
Pour faire une recherche sur une clé composée, il est possible d'utiliser la syntaxe suivante :
HLitRecherchePremier(<Nom du fichier>, <Nom de la clé composée>,
[<Valeur de recherche du premier élément de la clé composée>,
<Valeur de recherche du deuxième élément de la clé>, ...])
Exemple :
// Recherche de l'enregistrement
HLitRecherchePremier(CLIENT, NOM_PRENOM, ["MOULIN", "Françoise"])
2. Utilisation de la fonction HConstruitValClé
Exemple :
bufValRech est un Buffer = HConstruitValClé(CLIENT, NOM_PRENOM, sNom, sPrénom)
HRecherchePremier(CLIENT, NOM_PRENOM, bufValRech)
TANTQUE HTrouve(CLIENT)
        HSupprime(CLIENT)
        HSuivant(CLIENT, NOM_PRENOM)
FIN
3. Utilisation de la fonction HConvert
Pour construire la valeur d'une clé composée sans utiliser la fonction HConstruitValClé, il est nécessaire de :
  • compléter les composantes texte sur toute leur taille avec le caractère Caract(0).
  • convertir les composantes numériques grâce à la fonction HConvert.
Exemple :
MaClécomposée = Complète(Client.NomClient, Dimension(Client.Nom), Caract(0)) + ...
Complète(Client.Prénom, Dimension(Client.Prénom), Caract(0))
Hyper File 5.5 Les recherches génériques sur les clés composées fonctionnent uniquement si toutes les composantes de la clé composée sont de type Texte. Dans le cas contraire, une recherche à l'identique est effectuée.

Recherche sur une rubrique tableau

La recherche se fait uniquement sur le premier élément du tableau (élément d'indice 1). Pour effectuer une recherche sur les autres éléments du tableau, utilisez des filtres ou des requêtes.

Recherche et filtre

Si un filtre est actif (fonction HFiltre), la recherche tient compte du filtre uniquement si la clé utilisée est identique.
Pour prendre en compte ce filtre dans la suite du parcours (même si la clé de parcours n'est pas optimisée pour le filtre), utilisez la constante hRespecteFiltre.
Hyper File 5.5 Si un filtre est actif, la recherche ne tient pas compte du filtre.

Parcours des enregistrements correspondant à une condition

En général, la fonction HLitRecherchePremier permet de se positionner dans le fichier de données pour effectuer une boucle de parcours parmi les enregistrements correspondant à une condition. Les fonctions HLitSuivant et HLitPrécédent permettent de lire l'enregistrement suivant et précédent correspondant à la condition.
Pour ne plus tenir compte de la recherche lors du passage à l'enregistrement suivant ou précédent, il suffit d'utiliser une des fonctions suivantes :
WinDevWebDev - Code ServeurEtats et RequêtesAjaxCode Utilisateur (MCU)OLE DBAccès Natifs

Recherche à l'identique sous Access

Pour effectuer une recherche à l'identique sur une base de données ACCESS, il est conseillé d'utiliser la fonction SansEspace si des espaces sont présents à la fin de la valeur recherchée.
WinDevWebDev - Code ServeurWinDev MobileEtats et RequêtesWindows MobileUniversal Windows 10 AppiPhone/iPadAjaxCode Utilisateur (MCU)HFSQLHFSQL Client/ServeurHyper File 5.5OLE DBAccès Natifs

Blocages

Les blocages ne s'appliquent que lorsque un enregistrement a été trouvé.
Par défaut (pas de mode de blocage spécifié dans le paramètre <Options>), aucun blocage de l'enregistrement n'est réalisé.
Si un blocage est demandé (constantes hBlocageEcriture ou hBlocageLectureEcriture), la lecture de l'enregistrement sera réalisée uniquement si cet enregistrement n'est pas déjà bloqué.
Si le fichier de données est verrouillé par la fonction HDébutVerrou, il est inutile de spécifier un paramètre de blocage : le blocage spécifié avec la fonction HDébutVerrou est automatiquement pris en compte. Pour ne pas prendre en compte le blocage réalisé avec la fonction HDébutVerrou, utilisez la constante hBlocageNon.
Rappel : Un enregistrement bloqué peut être débloqué avec la fonction HDébloqueNumEnr.
OLE DBAccès Natifs Si le provider OLE DB ou l'Accès Natif utilisé ne gère pas les blocages, les options de blocage seront sans effet.
WinDevWebDev - Code ServeurEtats et RequêtesUniversal Windows 10 AppiPhone/iPadAjaxCode Utilisateur (MCU)HFSQLHFSQL Client/ServeurHyper File 5.5OLE DBAccès Natifs

Optimisation du temps de parcours

Pour optimiser le temps des premiers parcours d'un fichier de données, utilisez la fonction HOptimise sur ce fichier de données.
WinDevWebDev - Code ServeurEtats et RequêtesCode Utilisateur (MCU)Accès Natifs

Accès Natif XML

Le comportement de la fonction HLitRecherchePremier est lié aux fonctions HActiveFiltreAuto / HDésactiveFiltreAuto.
Par défaut, la fonction HActiveFiltreAuto est activée.
Ainsi, pour lire le contenu d'un document XML, il suffit de lire le contenu du fichier principal (le parent) puis des fichiers liés (les fils).
Par défaut, lors de la lecture dans un fichier, un filtre est automatiquement réalisé sur les fichiers reliés pour lire uniquement les enregistrements correspondant au fichier principal.
Par exemple :
Lors du parcours du fichier Person, il est possible de connaître l'email de cette personne.
Pour cela, il suffit de se positionner sur le fichier "Person", puis d'utiliser la fonction HLitRecherchePremier sur le fichier "email".
Dans ce cas, l'enregistrement lu dans le fichier "email" correspondra au premier email associé à l'enregistrement en cours dans le fichier "Person".
Si ce mécanisme est désactivé (fonction HDésactiveFiltreAuto), l'enregistrement lu dans le fichier "email" correspondra au premier enregistrement du fichier email (et non au fils de l'enregistrement lu dans le fichier "Person").
Composantes
WinDevWebDev - Code ServeurEtats et Requêtes wd210hf.dll
Windows Mobile wp210hf.dll
Java wd210java.jar
Linux wd210hf.so
Android wd210android.jar
Version minimum requise
  • Version 9
Documentation également disponible pour…
Commentaires
Cliquez sur [Ajouter] pour publier un commentaire