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
  • Divers
  • Blocage
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
Recule de plusieurs enregistrements dans le fichier de données, à partir de la position en cours, selon une rubrique spécifiée.
L'enregistrement destination est lu et chargé en mémoire : les variables HFSQL sont mises à jour (par exemple Client.Nom, c'est-à-dire la rubrique Nom du fichier Client).
Après l'exécution de la fonction HRecule, plusieurs cas peuvent se présenter :
  • il n'existe plus d'enregistrements dans le fichier de données : la fonction HEnDehors renvoie Vrai. Aucune lecture n'est effectuée.
  • la fonction tente de bloquer un enregistrement déjà bloqué en lecture : la fonction HErreurBlocage renvoie Vrai et la fonction HEnDehors renvoie Vrai.
    PHP La gestion des blocages n'est pas disponible en PHP.
    Java Accès par JDBC : La gestion des blocages n'est pas disponible pour les bases de données accédées par JDBC.
Cette fonction peut être utilisée indifféremment avec les fichiers de données, les vues HFSQL ou les requêtes.
Exemple
// Recule jusqu'au 200ème enregistrement du fichier de données Client
// selon la clé NomCli
HLitDernier(Client, NomCli)
HRecule(Client, NomCli, 199)
Syntaxe
<Résultat> = HRecule([<Fichier de données> [, <Rubrique>] [, <Pas> [, <Options>]]])
<Résultat> : Booléen
  • Vrai si le recul dans le fichier de données a été effectué,
  • Faux en cas d'erreur (blocage, fin du fichier de données, etc.) : l'enregistrement n'est pas lu. La fonction HErreur permet d'identifier l'erreur.
<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 nom n'est pas spécifié, la fonction HRecule va manipuler le dernier fichier de données utilisé par la dernière fonction de gestion HFSQL (fonction commençant par la lettre H).
<Rubrique> : Chaîne de caractères optionnelle
Nom de la rubrique selon laquelle le parcours est effectué. Si ce nom n'est pas spécifié, la fonction HRecule va manipuler la dernière rubrique du fichier de données utilisée par la dernière fonction de gestion HFSQL (fonction commençant par la lettre H).
OLE DBConnecteurs Natifs (Accès Natifs) Toutes les rubriques utilisées pour reculer dans le fichier sont considérées comme des rubriques clé.
PHP Si ce paramètre est spécifié, le paramètre <Pas> est obligatoire.
<Pas> : Entier optionnel
Nombre de pas en arrière (c'est-à-dire nombre d'enregistrements à parcourir). Par défaut, <Pas> = 1.
<Options> : Constante ou combinaison de constantes optionnelle de type entier
Paramètre :
  • le blocage de l'enregistrement lu. Par défaut, le blocage réalisé correspond au blocage en cours.
    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.

    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.
  • la gestion des doublons lors du parcours. Par défaut, tous les doublons sont parcourus.
    hDistinctLors d'un parcours sur une rubrique clé, s'il y a des doublons, un seul enregistrement est parcouru.
Hyper File 5.5 Le paramètre <Options> n'est pas pris en compte.
PHP Le paramètre <Options> n'est pas pris en compte.
Java Accès par JDBC : Le paramètre <Options> n'est pas pris en compte.
Remarques

Lecture selon une rubrique clé ou non

Dans tous les cas, le parcours doit avoir été initialisé avec une des fonctions suivantes : HLitPremier, HPremier, HLitRecherchePremier, HRecherchePremier, HChangeClé, HRetourPosition.
Si la rubrique utilisée est une clé :
  • si la constante hDistinct n'est pas active, la fonction HRecule permet de reculer de <Pas> valeurs de la clé à partir de la position en cours.
  • si la constante hDistinct est active, la fonction HRecule permet de reculer de <Pas> valeurs de la clé distinctes à partir de la position en cours. Si des doublons sont rencontrés, un seul doublon est lu.
Si la rubrique utilisée n'est pas une clé :
  • la constante hDistinct n'est pas disponible,
  • La fonction HRecule permet de reculer de <Pas> enregistrements actifs à partir de la position en cours.

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

Divers

  • Le résultat de la fonction HTrouve doit être ignoré (la fonction HTrouve doit être utilisée pour les recherches réalisées avec les fonctions HLitRecherche, HLitRecherchePremier, HLitRechercheDernier).
  • Le numéro de l'enregistrement en cours est connu avec la fonction HNumEnr.
  • La fonction HRecule respecte le filtre actif en cours (décrit avec la fonction HFiltre).
  • La fonction HChangeClé permet de modifier la clé de parcours tout en restant positionné sur l'enregistrement en cours.
  • La fonction HRecule(Client,Nom) est équivalent à HLitPrécédent(Client,Nom)
WINDEVWEBDEV - Code ServeurEtats et RequêtesUniversal Windows 10 AppiPhone/iPadJavaCode Utilisateur (MCU)Langage ExterneAjaxHFSQL ClassicHFSQL Client/ServeurHyper File 5.5OLE DBConnecteurs Natifs (Accès Natifs)

Blocage

Par défaut (aucune constante de blocage spécifiée), le blocage réalisé correspond au mode de blocage en cours.
Si un blocage est demandé (constantes hBlocageEcriture ou HBlocageLectureEcriture), la lecture de l'enregistrement et le blocage seront réalisés uniquement si cet enregistrement n'est pas déjà bloqué par une autre application.
Composante : wd290hf.dll
Version minimum requise
  • Version 9
Documentation également disponible pour…
Commentaires
Cliquez sur [Ajouter] pour publier un commentaire

Dernière modification : 25/05/2022

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