HListeFichier (Fonction)

DOCUMENTATION EN LIGNE
DE WINDEV, WEBDEV ET WINDEV MOBILE

Version :

Accueil | Connexion | Français

Aide / WLangage / Gestion des bases de données / HFSQL / Fonctions HFSQL

Fonction HListeFichier et le Connecteur Natif MySQL ou MariaDB

WINDEV

WEBDEV

WINDEV Mobile

Autres

Voir Aussi

HListeFichier (Fonction)

En anglais : HListFile

Non disponible avec ce type de connexion

Renvoie la liste des fichiers de données :

de l'analyse en cours.
des analyses en cours (cas des projets multi-analyses).
d'une analyse spécifique reconnue par le moteur HFSQL.
disponibles sur une connexion par un Connecteur Natif ou par un driver OLE DB.
d'un groupe défini dans l'éditeur d'analyses.
Les groupes définis dans l'éditeur d'analyses ne sont pas gérés.

Exemple

Voir des exemples supplémentaires

// Récupère les fichiers de données décrits dans l'analyse en cours et par programmation
ListeFichier est une chaîne
ListeFichier = HListeFichier(hLstDétail + hLstTout)
// Ajoute la liste des fichiers de données dans COMBO_COMBO1
ListeAjoute(COMBO_COMBO1, ListeFichier)
// Affiche dans une trace
Trace(ListeFichier)

Syntaxe

Lister les fichiers de données d'une analyse Masquer les détails

<Résultat> = HListeFichier([<Chemin du WDD> [, <Mot de passe du WDD>]] [, <Options>])

<Résultat> : Chaîne de caractères

Liste des fichiers de données présents dans l'analyse en cours ou dans l'analyse spécifiée.
Cas des projets multi-analyses : Si plusieurs analyses sont en cours, tous les fichiers de toutes les analyses en cours sont listées (sans doublons).
Les différentes descriptions de chaque analyse sont séparées par RC (Retour chariot). En fonction de la constante utilisée, le résultat est plus ou moins détaillé :
hLstDétail non précisé <Nom du fichier de données 1> + RC + <Nom du fichier de données 2> + RC + ...
hLstDétail précisé <Nom du fichier de données 1> + TAB + <Abréviation> + TAB + <Libellé> + TAB + <Nom physique> + RC + ...

Où :
<Nom du fichier de données X> : Nom logique du fichier de données (utilisé en programmation).
<Abréviation> : Abréviation du fichier de données.
<Libellé> : Libellé du fichier de données.
<Nom physique> : Nom physique du fichier de données (sur le disque). Ce nom correspond au nom court du fichier, sans extension ni chemin.

<Chemin du WDD> : Chaîne de caractères optionnelle

Chemin complet de l'analyse (c'est-à-dire du ficher .WDD) dans laquelle le fichier de données est décrit.
Si ce paramètre n'est pas précisé ou est égal à une chaîne vide (""), les fichiers de données à lister sont recherchés :
dans l'analyse en cours.
dans l'ensemble des analyses en cours (cas des projets multi-analyses).

<Mot de passe du WDD> : Chaîne de caractères optionnelle

Mot de passe défini pour l'analyse.
Si aucun mot de passe n'est défini, ce paramètre doit être égal à une chaîne vide ("").

<Options> : Constante ou combinaison de constantes de type entier (optionnel)

Paramètre le type de liste à effectuer :
hLstDétail Liste les informations détaillées (comme pour WINDEV 5.5).
hLstNormal
(valeur par défaut) Liste non triée, non détaillée, sans les fichiers de données décrits par programmation.
hLstTout Liste tous les fichiers de données (y compris ceux décrits avec les fonctions HDéclare, HDéclareExterne et HDécritFichier).
Ce paramètre n'est pas pris en compte.
hLstTriée Trie la liste des fichiers de données par ordre croissant.
Ce paramètre n'est pas pris en compte.

Lister les fichiers de données d'un groupe Masquer les détails

<Résultat> = HListeFichier(<Nom du groupe> [, <Options>])

<Résultat> : Chaîne de caractères

Liste des fichiers de données appartenant au groupe. Les différentes descriptions de chaque fichier de données sont séparées par RC (Retour chariot).

<Nom du groupe> : Chaîne de caractères

Nom du groupe de fichiers de données. Ce groupe de fichiers de données a été défini dans l'éditeur d'analyses.

<Options> : Constante ou combinaison de constantes de type entier (optionnel)

Paramètre le type des fichiers de données à lister :
hLstProcédureStockée Liste des procédures stockées.
hLstRequête Liste les requêtes qui ont été exécutées.
hLstTable
(valeur par défaut) Liste des tables utilisateur.
Les noms des tables correspondent aux noms physiques des fichiers des données.
hLstTableSystème Liste des tables système.
Cette option n'est pas disponible.
hLstVue Liste des vues.
Accès Natif Oracle : La constante hLstVue permet de lister les vues et les synonymes.

Liste les vues SQL.
hLstVueMatérialisée
Liste des vues matérialisées.

Lister les fichiers de données d'une connexion par Connecteur Natif, OLE DB ou HFSQL Client/Serveur (1) Masquer les détails

<Résultat> = HListeFichier(<Connexion> [, <Options>])

<Résultat> : Chaîne de caractères

Liste des fichiers de données accessibles par la connexion. Les différentes descriptions de chaque fichier de données sont séparées par RC (Retour chariot).

<Connexion> : Chaîne de caractères

Nom de la connexion à une base de données. Cette connexion a été définie dans l'éditeur d'analyses ou par la fonction HOuvreConnexion.

<Options> : Constante ou combinaison de constantes de type entier (optionnel)

Paramètre le type des fichiers de données à lister :
hLstProcédureStockée Liste des procédures stockées.
hLstRequête Liste les requêtes qui ont été exécutées.
hLstTable
(valeur par défaut) Liste des tables utilisateur.
Les noms des tables correspondent aux noms physiques des fichiers de données.
hLstTableSystème Liste des tables système.
Cette option n'est pas disponible.
hLstVue Liste des vues.
Connecteur Natif Oracle : La constante hLstVue permet de lister les vues et les synonymes.

Liste les vues SQL.
hLstVueMatérialisée
Liste des vues matérialisées.

Lister les fichiers de données d'une connexion par Connecteur Natif ou par OLE DB (2) Masquer les détails

<Résultat> = HListeFichier(<Nom utilisateur> , <Mot de passe> , <Source de données> , <Provider OLE DB ou Connecteur Natif> [, <Accès> [, <Options>]])

<Résultat> : Chaîne de caractères

Liste des fichiers de données accessibles par la connexion. Les différentes descriptions de chaque fichier de données sont séparées par RC (Retour chariot).

<Nom utilisateur> : Chaîne de caractères

Nom de l'utilisateur de la source de données.

<Mot de passe> : Chaîne de caractères

Mot de passe défini pour l'accès à la source de données (s'il existe), chaîne vide ("") si aucun mot de passe n'est défini.

<Source de données> : Chaîne de caractères

Chemin complet de la source de données utilisée.

<Provider OLE DB ou Connecteur Natif> : Chaîne de caractères ou constante

Nom du provider OLE DB à utiliser ou une des constantes suivantes :
hAccèsHF7 Pseudo-connexion à une base HFSQL Classic.
hAccèsHFClientServeur Connecteur Natif à une base HFSQL Client/Serveur.
hAccèsNatifAS400 Connecteur Natif AS/400 (module optionnel de WINDEV/WEBDEV).
hAccèsNatifDB2 Connecteur Natif DB2 (module optionnel de WINDEV/WEBDEV).
hAccèsNatifInformix Connecteur Natif Informix (module optionnel de WINDEV/WEBDEV).
hAccèsNatifMariaDB Connecteur Natif MariaDB (module optionnel de WINDEV/WEBDEV).
hAccèsNatifMySQL Connecteur Natif MySQL (module optionnel de WINDEV/WEBDEV).
hAccèsNatifOracle Connecteur Natif Oracle (module optionnel de WINDEV/WEBDEV).
hAccèsNatifOracleLite Connecteur Natif Oracle (module optionnel de WINDEV Mobile).
hAccèsNatifPostgreSQL Connecteur Natif PostgreSQL (module optionnel de WINDEV/WEBDEV).
hAccèsNatifProgress Connecteur Natif Progress (module optionnel de WINDEV/WEBDEV).
hAccèsNatifSQLAzure Connecteur Natif SQL Azure (module optionnel de WINDEV/WEBDEV, fourni avec le Connecteur Natif SQL Server).
hAccèsNatifSQLite Connecteur Natif SQLite.
hAccèsNatifSQLServer Connecteur Natif SQL Server (module optionnel de WINDEV/WEBDEV).
hAccèsNatifSQLServerMobile Connecteur Natif SQL Server (module optionnel de WINDEV Mobile).
hAccèsNatifSybase Connecteur Natif Sybase (module optionnel de WINDEV/WEBDEV).
hAccèsNatifXBase Connecteur Natif xBase (fourni en standard avec WINDEV/WEBDEV).
hAccèsNatifXML Connecteur Natif XML (fourni en standard avec WINDEV/WEBDEV).
hODBC Provider OLE DB pour ODBC (permet d'accéder à une source de données ODBC déclarée dans les sources de données ODBC de Windows).
hOledbAccess97 Provider OLE DB pour Access 97.
hOledbAccess2000 Provider OLE DB pour Access 2000.
hOledbAccess2007 Provider OLE DB pour Access 2007.
hOledbAccess2010 Provider OLE DB pour Access 2010.
hOledbDBase5 Provider OLE DB pour DBase 5.
hOledbExcel97 Provider OLE DB pour Excel 97.
hOledbExcel2000 Provider OLE DB pour Excel 2000.
hOledbExcel2007 Provider OLE DB pour Excel 2007.
hOledbLotus4 Provider OLE DB pour Lotus 4.
hOledbOracle Provider OLE DB pour Oracle.
hOledbSQLServer Provider OLE DB pour SQL Server.

Attention : Pour utiliser une connexion OLE DB il est nécessaire :
d'installer le MDAC version 2.6 minimum (installation réalisée avec WINDEV/WEBDEV et lors de la création de la version Client)
d'installer le provider OLE DB correspondant à la base de données manipulée.
Seuls les Connecteurs Natifs suivants peuvent être utilisés :
hAccèsNatifAS400 Connecteur Natif AS/400 (module optionnel de WEBDEV).
hAccèsNatifMariaDB Connecteur Natif MariaDB (module optionnel de WINDEV/WEBDEV).
hAccèsNatifMySQL Connecteur Natif MySQL (module optionnel de WEBDEV).
hAccèsNatifOracle Connecteur Natif Oracle (module optionnel de WEBDEV).
hAccèsNatifPostgreSQL Connecteur Natif PostgreSQL (module optionnel de WEBDEV).

<Accès> : Constante de type entier (optionnel)

Type d'accès à la base de données :
hOLecture Ouverture en lecture seule.
hOLectureEcriture
(valeur par défaut) Ouverture en Lecture/Ecriture.

<Options> : Constante ou combinaison de constantes de type entier (optionnelle)

Paramètre le type des fichiers de données à lister :
hLstProcédureStockée Liste des procédures stockées.
Cette option n'est pas disponible.
hLstRequête Liste les requêtes qui ont été exécutées.
hLstTable
(valeur par défaut) Liste des tables utilisateur.
Les noms des tables correspondent aux noms physiques des fichiers de données.
hLstTableSystème Liste des tables système.
Cette option n'est pas disponible.
hLstVue Liste des vues.
Connecteur Natif Oracle : La constante hLstVue permet de lister les vues et les synonymes.

Liste les vues SQL.
hLstVueMatérialisée
Liste des vues matérialisées.

Remarques

Fonction HListeFichier et le Connecteur Natif MySQL ou MariaDB

Pour le Connecteur Natif MySQL, la fonction HListeFichier a évolué selon les versions :
- En version 15, la fonction HListeFichier permet d'obtenir la liste des fichiers de la base de données en cours.
- En version 16, pour permettre l'utilisation des nouveautés MySQL 5, si le Connecteur Natif est connecté à un serveur MySQL 5 ou supérieur, la fonction HListeFichier renvoie la liste des fichiers de toutes les bases de données accessibles. Dans ce cas, le nom du fichier est de la forme "<Nom de la base de données>.<Nom du fichier>.
- A partir de la version 170069, la fonction HListeFichier renvoie désormais uniquement la liste des fichiers de la base de données en cours. La fonction HListeBaseDeDonnées permet de lister les bases de données accessibles et leurs fichiers.
Pour le Connecteur Natif MariaDB, la fonction HListeFichier renvoie uniquement la liste des fichiers de la base de données en cours. La fonction HListeBaseDeDonnées permet de lister les bases de données accessibles et leurs fichiers.

Composante : wd300hf.dll

Voir Aussi

Version minimum requise

Version 9

Documentation également disponible pour…

Commentaires

Cliquez sur [Ajouter] pour publier un commentaire

Dernière modification : 04/06/2024

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