|
|
|
|
|
- Rubrique de parcours
- Parcours des requêtes
- Blocages
- Mémos
- Mot de passe
- Connecteur Natif XML
- Divers
HLitPremier (Fonction) En anglais : HReadFirst
Non disponible avec ce type de connexion
Positionne sur le premier enregistrement d'un fichier de données en fonction d'une rubrique de parcours. L'enregistrement est lu et les variables HFSQL (par exemple Client.Nom, c'est-à -dire la rubrique Nom du fichier Client) sont mises à jour. 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). En général, la fonction HLitPremier permet de se positionner dans le fichier de données pour effectuer une boucle de lecture avec la fonction HLitSuivant. Après l'exécution de la fonction HLitPremier, 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 HFiltre) : aucune lecture n'est effectuée et la fonction HEnDehors renvoie Vrai.
- la fonction tente de lire un enregistrement déjà bloqué en lecture : aucune lecture n'est effectuée, la fonction HErreurBlocage renvoie Vrai et la fonction HEnDehors renvoie Vrai.
Accès par JDBC : La gestion des blocages n'est pas disponible sur 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.
HLitPremier(Client, Nom)
TANTQUE HEnDehors(Client) = Faux
HLitSuivant(Client, Nom)
FIN
Syntaxe
<Résultat> = HLitPremier([<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 HFSQL ou de la requête manipulé. Si ce paramètre correspond à une chaîne vide (""), la fonction HLitPremier 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 ou la vue (ce paramètre n'est pas pris en compte pour les requêtes). Si ce nom n'est pas spécifié, la fonction HLitPremier va utiliser :- Dans le cas d'un fichier de données : la dernière rubrique de parcours utilisée sur ce fichier 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 optionnelle Permet de paramétrer :- le blocage réalisé sur l'enregistrement lu par la fonction HLitPremier
- la prise en compte ou non du filtre précédemment défini.
| | hBlocageEcriture | Blocage 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.
| hBlocageLectureEcriture | Blocage en lecture/écriture : l'enregistrement en cours de lecture ne pourra ni être lu ni être modifié par une autre application.
| hBlocageNon | Aucun blocage : l'enregistrement pourra être lu ou modifié par une autre application pendant la lecture.
| hForwardOnly | | hRespecteFiltre | Le 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.
| hSansRafraîchir | |
Remarques Rubrique de parcours Si la rubrique de parcours utilisée est une clé, la fonction HLitPremier lit 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, HLitPremier lit le premier enregistrement "doublon" selon l'ordre des numéros d'enregistrement. Si la rubrique de parcours n'est pas une clé, la fonction HLitPremier lit le premier enregistrement actif. En cas de parcours du fichier, 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". 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). Mot de passe Si la fonction HLitPremier 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.
- Pour optimiser le temps des premiers parcours d'un fichier, utilisez la fonction HOptimise sur ce fichier de données.
- Cette fonction remplace les fonctions HLitPremierBloque et HLitPremierSansBloquer, conservées par compatibilité avec WINDEV 5.5.
Documentation également disponible pour…
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|