DOCUMENTATION EN LIGNE
DE WINDEVWEBDEV ET WINDEV MOBILE

Aide / WLangage / Gestion des bases de données / HFSQL / Fonctions HFSQL
  • Lecture selon une rubrique clé ou non
  • Mémos
  • Parcours des enregistrements correspondant à une condition
  • Modification de la valeur de la clé de parcours
  • Blocages
  • Divers
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 l'enregistrement suivant d'un fichier de données en fonction d'une rubrique de parcours. L'enregistrement est lu et les variables HFSQL sont mises à jour (par exemple Client.Nom, c'est-à-dire la rubrique Nom du fichier Client).
La lecture se fait de la plus petite valeur à la plus grande valeur de la rubrique de parcours (consultez les remarques pour plus de détails).
La fonction HLitSuivant permet de se positionner dans le fichier de données lors d'une boucle de parcours. Cette fonction peut être exécutée uniquement :
Après l'exécution de la fonction HLitSuivant, plusieurs cas peuvent se présenter :
  • le fichier est vide ou il n'existe pas d'enregistrement correspondant au filtre (défini par la fonction HFiltre) : aucune lecture n'est effectuée et la fonction HEnDehors renvoie Vrai.
  • 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.

    PHP Les blocages ne sont pas disponibles en PHP.

Cette fonction peut être utilisée indifféremment avec les fichiers de données, les vues HFSQL ou les requêtes.
Exemple
HLitPremier(Client, Nom)
TANTQUE HEnDehors() = Faux
// Traitement de l'enregistrement
HLitSuivant(Client, Nom)
FIN
Syntaxe
<Résultat> = HLitSuivant([<Fichier de données> [, <Rubrique de parcours>] [, <Options>]])
<Résultat> : Booléen
Correspond à :
  • Faux en cas d'erreur. Dans ce cas, la fonction HErreur renvoie un entier différent de 0. La fonction HErreurInfo permet d'obtenir plus de détails sur l'erreur. L'enregistrement n'est pas lu.
  • la valeur de la fonction HTrouve dans les autres cas (l'enregistrement peut être lu, même si <Résultat> renvoie Faux).
<Fichier de données> : Chaîne de caractères optionnelle
Nom du fichier de données, de la vue ou de la requête manipulé. Si ce paramètre correspond à une chaîne vide (""), la fonction HLitSuivant manipule le dernier fichier de données utilisé par la dernière fonction de gestion HFSQL (fonction commençant par la lettre H).
<Rubrique de parcours> : Chaîne de caractères optionnelle
Nom de la rubrique utilisée pour parcourir le fichier de données, la vue ou la requête. Si ce nom n'est pas spécifié, la fonction HLitSuivant va utiliser :
  • Dans le cas d'un fichier de données : la dernière rubrique de parcours utilisée sur ce fichier de données par la dernière fonction de gestion HFSQL (fonction commençant par la lettre H). Si cette rubrique n'existe pas, la meilleure rubrique de parcours est automatiquement utilisée.
  • Dans le cas d'une requête : le ORDER BY de la requête si il existe, sinon selon la dernière rubrique utilisée.
  • Dans le cas d'une vue : la rubrique de tri de la vue (si elle existe), sinon sur la dernière rubrique utilisée.
<Options> : Constante ou combinaison de constantes optionnelle
Permet de paramétrer :
  • le blocage réalisé sur l'enregistrement lu par la fonction HLitSuivant
  • la gestion des doublons. Par défaut, tous les doublons sont parcourus.
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.
hBlocageNonAucun blocage : l'enregistrement pourra être lu ou modifié par une autre application pendant la lecture.
hDistinctSi des doublons sont présents, ce paramètre permet de lire un seul enregistrement parmi les doublons. Ce paramètre est pris en compte uniquement si le parcours est réalisé sur une rubrique clé.

OLE DBConnecteurs Natifs (Accès Natifs) Cette constante n'est pas prise en compte.

OLE DBConnecteurs Natifs (Accès Natifs) Si le provider OLE DB ou le Connecteur Natif (également appelé Accès Natif) utilisé ne gère pas les blocages, les options de blocage seront sans effet.
OLE DB Les options de blocages spécifiées dans la fonction HLitSuivant ne sont pas prises en compte. Le mode de blocage spécifié avec la fonction HLitPremier ou HLitDernier restera effectif lors des appels aux fonctions HLitSuivant et HLitPrécédent.
Pour modifier le mode de blocage, il est nécessaire d'utiliser :
PHP Le paramètre <Options> est ignoré.
Remarques

Lecture selon une rubrique clé ou non

Si la rubrique utilisée est une clé, la fonction HLitSuivant lit l'enregistrement pour lequel la valeur de la clé est la plus grande. L'ordre de tri pris en compte est l'ordre de tri spécifié dans l'analyse pour cette clé.
Remarque : Dans le cas d'une boucle de recherche (fonction HLitRecherchePremier par exemple), quand la fonction HLitSuivant lit l'enregistrement pour lequel la valeur de la clé est la plus grande, la fonction HTrouve permet de savoir si l'enregistrement correspond au critère de la recherche ou non.
Si la rubrique n'est pas une clé, la fonction HLitSuivant lit l'enregistrement actif suivant. En cas de parcours du fichier de données, les enregistrements seront triés selon leur numéro d'enregistrement.
Dans ce cas, la rubrique de parcours sélectionnée apparaîtra en rouge sous l'éditeur de code et un warning sera affiché dans le volet "Code".
Remarque : La complétion automatique propose uniquement les rubriques clés.

Mémos

Les mémos associés à l'enregistrement peuvent être automatiquement lus ou non lors de la lecture de l'enregistrement. La fonction HGèreMemo permet de personnaliser cette lecture automatique.
Si les mémos sont gérés, lorsque l'enregistrement est lu, les mémos texte associés sont également lus. Les mémos binaires ne sont lus que lorsqu'ils sont utilisés explicitement (fonction HExtraitMémo).

Parcours des enregistrements correspondant à une condition

En général, les fonctions HLitRecherche, HLitRecherchePremier, HLitRechercheDernier permettent 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 ou précédent correspondant à la condition :
  • si la rubrique utilisée est une clé, la fonction HLitSuivant lira les enregistrements suivants correspondant aux valeurs supérieures ou égales à la valeur recherchée.
  • si la rubrique utilisée n'est pas une clé, la fonction HLitSuivant lira les enregistrements suivants correspondant aux valeurs égales à la valeur recherchée.
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 :
Attention : si un parcours doit être effectué avec la fonction HLitSuivant, la recherche initiale (fonctions HLitRecherche, HLitRecherchePremier, HLitRechercheDernier) ne doit pas utiliser la constante hLimiteParcours.

Modification de la valeur de la clé de parcours

Si la valeur de la rubrique de parcours est modifiée avant d'utiliser la fonction HLitSuivant, l'enregistrement en cours pourra être lu à nouveau dans la suite du parcours par la fonction HLitSuivant.
En effet, la modification de la rubrique de parcours met à jour la clé d'index du fichier. Lors de la lecture des enregistrements suivants, cette modification est prise en compte.
Cette remarque est également valable lors de l'utilisation de la fonction HLitSuivant sans clé de parcours sur une requête triée (ORDER BY).
WEBDEV - Code ServeurAjaxHFSQL ClassicHFSQL Client/ServeurProcédures stockéesHyper File 5.5OLE DBConnecteurs Natifs (Accès Natifs)

Blocages

Par défaut (paramètre <Option> non spécifié), aucun blocage de l'enregistrement n'est réalisé.
Si un blocage est spécifié (paramètres hBlocageEcriture ou hBlocageLectureEcriture), la lecture de l'enregistrement sera réalisée uniquement si cet enregistrement n'est pas déjà bloqué.
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.

Divers

  • Le numéro de l'enregistrement en cours est connu avec la fonction HNumEnr.
  • La fonction HChangeClé permet de modifier la clé de parcours, tout en restant positionné sur l'enregistrement en cours.
  • Pour optimiser le temps des premiers parcours d'un fichier de données, utilisez la fonction HOptimise sur ce fichier de données.
Composante : wd290hf.dll
Version minimum requise
  • Version 9
Documentation également disponible pour…
Commentaires
Cliquez sur [Ajouter] pour publier un commentaire

Dernière modification : 03/07/2023

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