DOCUMENTATION EN LIGNE
DE WINDEVWEBDEV ET WINDEV MOBILE

Aide / WLangage / Gestion des bases de données / HFSQL / Fonctions HFSQL
  • Lecture selon une clé
  • Vérification du mot de passe
  • Divers
  • Comparaison des fonctions HLitPremier et HPremier
  • 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 d'un fichier de données en fonction de la rubrique de parcours spécifié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 :
HSupprime(Client)
mais
HSupprime(Client, HNumEnr())
La lecture se fait de la plus petite à la plus grande valeur de la rubrique de parcours (consultez les remarques pour plus de détails).
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 HPremier permet de se positionner dans le fichier de données pour effectuer une boucle de parcours parmi les enregistrements correspondant à une condition. La fonction HSuivant permet de se positionner sur l'enregistrement suivant correspondant à la condition.
Après l'exécution de la fonction HPremier, plusieurs cas peuvent se présenter :
  • un enregistrement correspondant à la condition a été trouvé : 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
Remarques :
  • Par défaut, les fonctions HRecherchePremier et HRechercheDernier permettent de réaliser une recherche à l'identique.
  • Par défaut, la fonction HPremier effectue une recherche générique.

La lecture se fait de la plus petite à la plus grande valeur de la rubrique de parcours (consultez les remarques pour plus de détails).
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 HPremier permet de se positionner dans le fichier de données pour effectuer une boucle de lecture avec la fonction HSuivant.
Après l'exécution de la fonction HPremier, plusieurs cas peuvent se présenter :
  • le fichier de données est vide ou il n'existe pas d'enregistrement correspondant au filtre (défini par la fonction HFiltre) : 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.
    Java Accès par JDBC : La gestion des blocages n'est pas disponible sur les bases de données accédées par JDBC.
Exemple
HPremier(Client, Nom)
TANTQUE HEnDehors() = Faux
// Traitement de l'enregistrement
HSuivant(Client, Nom)
FIN
Syntaxe
<Résultat> = HPremier([<Fichier de données> [, <Rubrique clé de parcours>] [, <Options>]])
<Résultat> : Booléen
  • Vrai si le positionnement sur l'enregistrement a été effectué,
  • Faux en cas d'erreur. 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.
<Fichier de données> : Chaîne de caractères optionnelle
Nom du fichier de données manipulé. Si ce paramètre correspond à une chaîne vide (""), la fonction HPremier manipule le dernier fichier de données utilisé par la dernière fonction de gestion HFSQL (fonction commençant par la lettre H).
<Rubrique clé de parcours> : Chaîne de caractères optionnelle
Nom de la rubrique clé utilisée pour parcourir le fichier de données. Si ce nom n'est pas spécifié, la fonction HPremier va manipuler 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.
<Options> : Constante optionnelle
Paramètre le blocage réalisé sur l'enregistrement sélectionné par la fonction HPremier :
hBlocageEcritureBlocage en écriture : l'enregistrement sélectionné pourra être lu par une autre application mais ne pourra pas être modifié par une autre application.
Java Accès par JDBC : Cette constante n'est pas disponible.
hBlocageLectureEcritureBlocage en lecture/écriture : l'enregistrement sélectionné ne pourra ni être lu ni être modifié par une autre application.
OLE DB Blocage en écriture : l'enregistrement sélectionné pourra être lu par une autre application mais ne pourra pas être modifié par une autre application. Équivalent à la constante hBlocageEcriture.

Java Accès par JDBC : Cette constante n'est pas disponible.
hBlocageNonAucun blocage : l'enregistrement pourra être lu ou modifié par une autre application.
Java Accès par JDBC : Cette constante n'est pas disponible.
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.
hSansRafraîchir
OLE DB Le contenu de la table ou de la requête ne sera pas rafraîchi. Toutes les positions sauvegardées sont conservées. Si ce paramètre n'est pas précisé, la fonction HPremier réinitialise le parcours pour la rubrique spécifiée : le contenu de la table ou de la requête est rafraîchi avec les données de la base de données OLE DB. Toutes les positions sauvegardées sont perdues. La restauration de la position sera effectuée à partir de la valeur de la meilleure rubrique.
Remarque : Les parcours et les positions sauvegardées sur les autres rubriques ne sont jamais affectés.
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 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 HPremier restera effectif lors des appels aux fonctions HPrécédent et HSuivant.
Pour modifier le mode de blocage, il est nécessaire d'utiliser :
Connecteurs Natifs (Accès Natifs) Oracle : il est possible de spécifier un mode de blocage différent pour chaque enregistrement. Cependant, si une transaction a été démarrée à l'aide de la fonction SQLTransaction avant de procéder au blocage, le blocage ne sera relâché qu'à la fin de la transaction (fonction SQLTransaction avec la constante sqlFin ou sqlAnnule).
Hyper File 5.5 Les options de blocage ne sont pas prises en compte. Utilisez des fonctions de blocage (fonction HBloqueNumEnr) conservées par compatibilité.
Remarques

Lecture selon une clé

La fonction HPremier positionne sur l'enregistrement pour lequel la valeur de la clé est la plus petite.
L'ordre de tri pris en compte est l'ordre de tri spécifié dans l'analyse pour cette clé.
En cas de doublons, la fonction HPremier positionne sur le premier enregistrement "doublon" selon l'ordre des numéros d'enregistrement.
WINDEVWEBDEV - Code ServeurEtats et RequêtesUniversal Windows 10 AppiPhone/iPadJavaCode Utilisateur (MCU)AjaxHFSQL ClassicHFSQL Client/ServeurHyper File 5.5

Vérification du mot de passe

Si la fonction HPremier est la première fonction manipulant le fichier de données spécifié, la vérification du mot de passe est effectuée lors de l'ouverture du fichier de données.
Si le mot de passe est incorrect, la fonction HErreurMotDePasse renvoie Vrai et la fonction HEnDehors renvoie Vrai.

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.

Comparaison des fonctions HLitPremier et HPremier

La fonction HPremier ne lit pas l'enregistrement : la fonction HPremier est donc plus rapide que la fonction HLitPremier.
WINDEVWEBDEV - Code ServeurWINDEV MobileEtats et RequêtesUniversal Windows 10 AppiPhone/iPadCode Utilisateur (MCU)AjaxHFSQL ClassicHFSQL Client/ServeurHyper 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 demandé (constantes hBlocageEcriture ou hBlocageLectureEcriture), le positionnement sur l'enregistrement sera réalisé uniquement si cet enregistrement n'est pas déjà bloqué.
Composante : wd290hf.dll
Version minimum requise
  • Version 9
Documentation également disponible pour…
Commentaires
Cliquez sur [Ajouter] pour publier un commentaire

Dernière modification : 04/07/2023

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