DOCUMENTATION EN LIGNE
DE WINDEVWEBDEV ET WINDEV MOBILE

Aide / WLangage / Gestion des bases de données / HFSQL / Fonctions HFSQL
  • Recherche générique/Recherche à l'identique
  • Recherche sur une clé composée
  • Recherche sur une rubrique tableau
  • Recherche et filtre
  • Blocages
WINDEV
WindowsLinuxUniversal Windows 10 AppJavaEtats et RequêtesCode Utilisateur (MCU)
WEBDEV
WindowsLinuxPHPWEBDEV - Code Navigateur
WINDEV Mobile
AndroidWidget AndroidiPhone/iPadWidget IOSApple WatchMac CatalystUniversal Windows 10 App
Autres
Procédures stockées
Positionne sur le premier enregistrement du fichier de données dont la valeur d'une rubrique spécifique est supérieure ou égale à une valeur recherchée. L'enregistrement n'est pas lu.
Le numéro de l'enregistrement en cours est modifié uniquement lorsqu'il est renvoyé par la fonction HNumEnr. Pour les fonctions manipulant par défaut le numéro de l'enregistrement en cours (fonctions HSupprime, HLit, HModifie, ...), la valeur de ce numéro n'est pas mise à jour : il faut utiliser la fonction HNumEnr.
Par exemple, ne pas faire :
// Supprime un enregistrement ne correspondant pas à celui voulu
HRecherchePremier(Client, IDClient, 25)
HSupprime(Client)
mais faire :
// Suppression de l'enregistrement recherché
HRecherchePremier(Client, IDClient, 25)
HSupprime(Client, HNumEnr())

Attention : L'enregistrement chargé en mémoire n'est pas modifié. Les variables HFSQL (par exemple Client.Nom, c'est-à-dire la rubrique Nom du fichier Client) ne sont pas mises à jour.
En général, la fonction HRecherchePremier permet de se positionner dans le fichier de données pour effectuer une boucle de parcours parmi les enregistrements correspondant à une condition.
Après l'exécution de la fonction HRecherchePremier, 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.
  • le fichier de données est vide ou il n'existe pas d'enregistrement correspondant à la condition : la fonction HEnDehors renvoie Vrai.
  • la fonction tente de bloquer un enregistrement déjà bloqué en lecture : la fonction HErreurBlocage renvoie Vrai et la fonction HEnDehors renvoie Vrai.
Remarque : la recherche peut être annulée grâce à la fonction HAnnuleRecherche.
Exemple
// Recherche du premier enregistrement pour lequel
// le nom du Client est Dupond
HRecherchePremier(Client, Nom, "Dupond")
// L'enregistrement n'est pas lu.
// Recherche tous les clients ayant un certain nom et prénom.
// La recherche se fait selon une clé composée.
bufValRech est un Buffer = HConstruitValClé(Client, Nom_Prénom, sNom, sPrénom)
HRecherchePremier(Client, Nom_Prénom, bufValRech, hBlocageEcriture)
TANTQUE HTrouve(Client) = Vrai
HSupprime(Client, HNumEnr())
HSuivant(Client, Nom_Prénom, hBlocageEcriture)
FIN
Syntaxe
<Résultat> = HRecherchePremier(<Fichier de données> , <Rubrique clé> , <Valeur recherchée> [, <Options>])
<Résultat> : Booléen
  • Vrai si le positionnement sur l'enregistrement a été effectué (correspond à la valeur de HTrouve).
  • Faux en cas de problème. Ce problème peut être dû :
    • soit à un problème de positionnement (fichier de données vide, etc.) : 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.
<Fichier de données> : Chaîne de caractères
Nom du fichier de données HFSQL manipulé.
<Rubrique clé> : Chaîne de caractères
Nom de la rubrique clé sur laquelle la recherche doit être effectuée.
<Valeur recherchée> : Type correspondant à la valeur
Valeur de la rubrique recherchée.
<Options> : Constante ou combinaison de constantes optionnelle
Paramètre :
  • le mode de blocage de l'enregistrement recherché
  • le type de recherche effectué.
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.
hBlocageLectureEcritureBlocage en lecture/écriture : l'enregistrement en cours de lecture ne pourra ni être lu ni être modifié par une autre application.
OLE DB Blocage en écriture seulement. Fonctionnement équivalent à la constante hBlocageEcriture.
hBlocageNonAucun blocage : l'enregistrement pourra être lu ou modifié par une autre application pendant la lecture.
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. 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.
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 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 HRecherchePremier ne prend pas en compte le filtre.
OLE DBConnecteurs Natifs (Accès Natifs) Si le provider OLE DB ou le Connecteur 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 HRecherchePremier restera effectif lors des appels aux fonctions HPrécédent et HSuivant.
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 enregistrement 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 (HTrouve renvoie Vrai).
  • Recherche à l'identique : Recherche tous les enregistrement 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éeOptionsHRecherchePremier positionne sur l'enregistrementHTrouve 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)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)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.
WEBDEV - Code ServeurAjaxHFSQL ClassicHFSQL Client/ServeurHyper File 5.5OLE DBConnecteurs Natifs (Accès Natifs)

Recherche sur une clé composée

Plusieurs méthodes permettent de faire une recherche sur une clé composée :
Utilisation d'une liste de valeurs
Pour faire une recherche sur une clé composée, il est possible d'utiliser la syntaxe suivante :
HRecherchePremier(<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
HRecherchePremier(Client, Nom_Prénom, ["Moulin","Françoise"])
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.
Hyper File 5.5 Si un filtre est actif, la recherche ne tient pas compte du filtre.
WEBDEV - Code ServeurAjaxHFSQL ClassicHFSQL Client/ServeurHyper File 5.5OLE DBConnecteurs Natifs (Accè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é.
Rappel : Un enregistrement bloqué peut être débloqué avec la fonction HDébloqueNumEnr.
OLE DBConnecteurs Natifs (Accès Natifs) Si le provider OLE DB ou le Connecteur Natif utilisé ne gère pas les blocages, les options de blocage seront sans effet.
Composante : wd290hf.dll
Version minimum requise
  • Version 9
Documentation également disponible pour…
Commentaires
Cliquez sur [Ajouter] pour publier un commentaire

Dernière modification : 12/07/2022

Signaler une erreur ou faire une suggestion | Aide en ligne locale