DOCUMENTATION EN LIGNE
DE WINDEV, WEBDEV ET WINDEV MOBILE
Aide / WLangage / Gestion des bases de données / HFSQL / Fonctions HFSQL
  • Comment décrire un fichier de données par programmation ?
  • Liste des propriétés HFSQL utilisables pour décrire un fichier de données par programmation
  • Les types de fichiers de données pouvant être décrits avec la fonction HDécritFichier
  • Syntaxe 2 : Description de fichier de données (compatibilité 5.5)
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
Décrit un fichier de données par programmation.
Après l'appel à la fonction HDécritFichier :
  • le fichier de données peut être manipulé comme n'importe quel fichier décrit dans l'analyse.
  • la description du fichier de données ne peut plus être modifiée.
  • la variable de description du fichier de données est ré-initialisée. Une nouvelle description de fichier de données peut être effectuée.
Pour annuler la description de fichier de données par programmation, utilisez la fonction HAnnuleDéclaration.
Exemple
// Exemple utilisant la syntaxe 1
UnFichier est une Description de Fichier
UneRubrique est une Description de Rubrique
Client est une Source de Données

// Description du fichier de données "Client"
UnFichier.Nom = "Client"
UnFichier.Type = hFichierNormal
UnFichier.CryptageFic = hCryptageStandard

// Description de la rubrique "Nom"
UneRubrique.Nom = "NOM"
UneRubrique.Type = hRubTexte
UneRubrique.Taille = 40
UneRubrique.TypeClé = hCléUnique
HDécritRubrique(UnFichier, UneRubrique)

// Description de la rubrique "Prénom"
UneRubrique.Nom = "PRENOM"
UneRubrique.Type = hRubTexte
UneRubrique.Taille = 40
HDécritRubrique(UnFichier, UneRubrique)

// Valide la description du fichier de données 
HDécritFichier(UnFichier)
...

// Création du fichier de données Client (reconnu car déclaré comme source de données)
HCréation(Client)

// Création d'un enregistrement
Client.Nom = "Dupont"
Client.Prénom = "André"
HAjoute(Client)
// Exemple utilisant la syntaxe 2
UneDescriptionFichier est une Description de Fichier
UneRubrique est une Description de Rubrique
sdSource est une Source de Données 
 
// Description du fichier de données "CLIENT"
UneDescriptionFichier.Nom = "CLIENT"
UneDescriptionFichier.Type = hFichierNormal
UneDescriptionFichier.CryptageFic = hCryptageStandard
 
// Description de la rubrique "NOM"
UneRubrique.Nom = "NOM"
UneRubrique.Type = hRubTexte
UneRubrique.Taille = 40
UneRubrique.TypeClé = hCléUnique
HDécritRubrique(UneDescriptionFichier, UneRubrique)
 
// Description de la rubrique "PRENOM"
UneRubrique.Nom = "PRENOM"
UneRubrique.Type = hRubTexte
UneRubrique.Taille = 40
HDécritRubrique(UneDescriptionFichier, UneRubrique)
 
// Valide la description du fichier de données
HDécritFichier(sdSource, UneDescriptionFichier)

HCréation(sdSource)
Syntaxe

Décrire un fichier de données par programmation Masquer les détails

<Résultat> = HDécritFichier(<Fichier de données>)
<Résultat> : Booléen
  • Vrai si la description du fichier de données est valide et peut être utilisée,
  • Faux en cas de problème. La fonction HErreurInfo permet d'identifier l'erreur.
<Fichier de données> : Variable de type Description de fichier
Nom de la variable de type Description de Fichier (voir paragraphe Notes) permettant de décrire le fichier de données. Le nom du fichier de données sera défini grâce à la propriété Nom.

Décrire un fichier de données par programmation via une source de données Masquer les détails

<Résultat> = HDécritFichier(<Source de données> , <Fichier de données>)
<Résultat> : Booléen
  • Vrai si la description du fichier de données est valide et peut être utilisée,
  • Faux en cas de problème. La fonction HErreurInfo permet d'identifier l'erreur.
<Source de données> : Variable de type Source de données
Nom de la variable de type Source de données associée au fichier de données.
<Fichier de données> : Variable de type Description de fichier
Nom de la variable de type Description de Fichier (voir paragraphe Notes) permettant de décrire le fichier de données. Le nom du fichier de données sera défini grâce à la propriété Nom.
WINDEVWEBDEV - Code ServeurEtats et RequêtesWindowsCode Utilisateur (MCU)AjaxHyper File 5.5

Décrire un fichier de données au format Hyper File 5.5 par programmation (compatibilité uniquement) Masquer les détails

<Résultat> = HDécritFichier(<Fichier de données> , <Abréviation> [, <Chemin d'accès>])
<Résultat> : Booléen
  • Vrai si l'opération a été réalisée,
  • Faux en cas de problème. La fonction HErreurInfo permet d'identifier l'erreur.
<Fichier de données> : Chaîne de caractères
Nom du fichier de données temporaire à créer. Ce fichier de données temporaire est au format Hyper File 5.5.
<Abréviation> : Chaîne de 2 caractères
Préfixe du fichier de données.
<Chemin d'accès> : Chaîne de caractères optionnelle
Nom du répertoire ou du lecteur dans lequel sera créé le fichier de données physique. Si ce paramètre n'est pas précisé, le fichier de données sera créé (fonction HCréation) dans le répertoire courant des programmes.
Remarques

Comment décrire un fichier de données par programmation ?

Pour décrire un fichier de données par programmation, il faut :
  • Solution 1 (syntaxe 1) : Description directe
    1. Utiliser des variables de type Description de Fichier, Description de Rubrique, Description de Liaison et Description d'IndexFullText (si nécessaire).
    2. Décrire les caractéristiques du fichier de données, de ses rubriques, de ses liaisons et de ses index full-text (si nécessaire) grâce aux propriétés HFSQL.
    3. Fixer la description des rubriques avec la fonction HDécritRubrique.
    4. Fixer la description des index full-text avec la fonction HDécritIndexFullText.
    5. Fixer la description du fichier de données (fonction HDécritFichier, syntaxe 1) et des liaisons si nécessaire (fonction HDécritLiaison).
  • Solution 2 (syntaxe 2) : Description à l'aide d'une source de données
    Cette solution permet d'associer le fichier de données décrit à une source de données. Dans ce cas, lorsque cette variable sera supprimée, le fichier de données sera également supprimé.
    Attention : Pour utiliser cette syntaxe, il est nécessaire d'utiliser une source de données "automatique". Pour plus de détails, consultez Description du projet : Onglet Compilation.
    1. Déclarer une variable de type Source de données.
    2. Utiliser des variables de type Description de Fichier, Description de Rubrique, Description de Liaison et Description d'IndexFullText (si nécessaire).
    3. Décrire les caractéristiques du fichier de données, de ses rubriques, de ses liaisons et de ses index full-text (si nécessaire) grâce aux propriétés HFSQL.
    4. Fixer la description des rubriques avec la fonction HDécritRubrique.
    5. Fixer la description des index full-text avec la fonction HDécritIndexFullText.
    6. Associer la description du fichier de données à la source de données (fonction HDécritFichier, syntaxe 2) et des liaisons si nécessaire (fonction HDécritLiaison).

Liste des propriétés HFSQL utilisables pour décrire un fichier de données par programmation

Les propriétés suivantes sont disponibles en lecture et écriture.
CompressionMmoLa propriété CompressionMmo permet de paramétrer le mode de compression du fichier MMO (contenant les mémo binaires et texte) associé au fichier de données.
CryptageFicLa propriété CryptageFic permet de paramétrer le mode de cryptage du fichier de données.
CryptageMmoLa propriété CryptageMmo permet de paramétrer le mode de cryptage du fichier mémo (d'extension .MMO) associé au fichier de données.
CryptageNdxLa propriété CryptageNdx permet de paramétrer le mode de cryptage du fichier d'index (d'extension .NDX) associé au fichier de données.
CxAccèsLa propriété CxAccès permet de gérer le type d'accès au fichier de données lors de la connexion OLE DB à une table spécifique.
CxAccèsDécritLa propriété CxAccèsDécrit permet de gérer le type d'accès au fichier de données lors de la connexion OLE DB à une table spécifique.
CxBaseDeDonnéesLa propriété CxBaseDeDonnées permet de gérer la source de données OLE DB lors de la connexion OLE DB à une table spécifique.
CxBaseDeDonnéesDécriteLa propriété CxBaseDeDonnéesDécrite permet de gérer la source de données OLE DB lors de la connexion OLE DB à une table spécifique.
CxLibelléDécritLa propriété CxLibelléDécrit permet de gérer le libellé de la connexion à la source de données OLE DB.
CxMotDePasseDécritLa propriété CxMotDePasseDécrit permet de définir le mot de passe utilisé pour ouvrir le fichier lors d'une connexion OLE DB (fichier défini par programmation uniquement).
CxProviderOLEDBLa propriété CxProviderOLEDB permet de gérer le nom du provider OLE DB (appelé aussi serveur OLE DB).
CxProviderOLEDBDécritLa propriété CxProviderOLEDBDécrit permet de gérer le nom du provider OLE DB (appelé aussi serveur OLE DB).
CxUtilisateurLa propriété CxUtilisateur permet de paramétrer le nom de l'utilisateur utilisé lors de la connexion OLE DB à une table spécifique.
CxUtilisateurDécritLa propriété CxUtilisateurDécrit permet de paramétrer le nom de l'utilisateur utilisé lors de la connexion OLE DB à une table spécifique.
FormatLa propriété Format permet de paramétrer le format des données du fichier de données.
GrosFichierLa propriété GrosFichier permet de paramétrer la taille maximale possible d'un fichier de données.
JournalisationLa propriété Journalisation permet de :
  • connaître le mode de journalisation utilisé pour un fichier de données (fichier défini sous l'éditeur d'analyses ou défini par programmation).
  • définir le mode de journalisation utilisé pour un fichier de données (lors de la description du fichier par programmation uniquement).
MotDePasseWDD55La propriété MotDePasseWDD55 permet de spécifier le mot de passe de l'analyse au format 5.5 lors de la description par programmation d'un fichier de données au format Hyper File 5.5 dans une analyse au format HFSQL Classic.
NomLa propriété Nom permet de connaître :
  • le nom de la police associée à une variable de type Police.
  • le nom d'un champ, d'un état ou d'un bloc d'un état.
  • le nom d'un champ, d'un groupe de champs ou d'une fenêtre.
  • le nom d'un champ, d'un groupe de champs ou d'une page.
Nom55La propriété Nom55 permet de gérer le nom logique d'un fichier de données au format Hyper File 5.5 non migré et présent dans une analyse au format WINDEV 19.
NomDécritLa propriété NomDécrit permet de gérer le nom logique des fichiers de données HFSQL (sans tenir compte des éventuelles modifications effectuées par la fonction HAlias).
NomPhysiqueLa propriété NomPhysique permet de gérer le nom physique des fichiers de données HFSQL.
NomPhysiqueDécritLa propriété NomPhysiqueDécrit permet de gérer le nom physique des fichiers de données HFSQL.
RépertoireLa propriété Répertoire permet de gérer le répertoire physique des fichiers de données HFSQL.
RépertoireDécritLa propriété RépertoireDécrit permet de gérer le répertoire physique des fichiers de données HFSQL.
RépertoireJournalLa propriété RépertoireJournal permet de gérer le répertoire du fichier journal décrit dans l'analyse.
RubriqueTexteComplétéeLa propriété RubriqueTexteComplétée permet de paramétrer la gestion des rubriques texte dans un fichier de données HFSQL.
SécuriséLa propriété Sécurisé permet de paramétrer le niveau de sécurité du cryptage des fichiers de données.
TypeLa propriété Type permet de connaître :
  • le type d'un élément décrit par programmation (description de rubrique ou de fichier) ou non (fichier ou rubrique défini sous l'éditeur d'analyses, vue ou requête).
  • le type d'un objet.
  • le type de la valeur stockée dans un variant.
WDD55La propriété WDD55 permet de :
  • Connaître le nom et le chemin complet du fichier WDD au format Hyper File 5.5.
  • Définir le nom et le chemin complet du fichier WDD au format Hyper File 5.5.

Les types de fichiers de données pouvant être décrits avec la fonction HDécritFichier

La propriété Type permet de spécifier le type du fichier de données à créer.
Les types suivants peuvent être créés avec la fonction HDécritFichier :
hFichierAS400Fichier AS 400
hFichierNormalFichier normal
hFichierOLEDBFichier OLE DB
hFichierOracleFichier Oracle
hFichierSQLAzureFichier SQL Azure
hFichierSQLServerFichier SQL Server
hFichierSybaseFichier Sybase
hFichierXBaseFichier xBase
WINDEVWEBDEV - Code ServeurWindowsHyper File 5.5

Syntaxe 2 : Description de fichier de données (compatibilité 5.5)

Cette syntaxe permet de créer des fichiers de données temporaires au format Hyper File 5.5. Cette syntaxe n'est utilisable que dans une application réalisée avec WINDEV 5.5 ou WEBDEV 1.5 et migrée vers WINDEV 7 ou supérieure. Pour utiliser cette fonction, il est nécessaire que :
  • l'analyse au format Hyper File 5.5 soit accessible sur le poste de développement et chargée.
  • le chemin de l'analyse Hyper File 5.5 soit spécifié dans les caractéristiques de l'analyse (onglet "Détail").
Classification Métier / UI : Code métier
Composante : wd300hf.dll
Voir Aussi
Version minimum requise
  • Version 9
Documentation également disponible pour…
Commentaires
HDécritFichier fonctionne avec unFichier..type=hFichierVue
L'utilisation de la propriété ..type=hFichierVue permet de décrire une vue avec HDécritFichier
Bloch 38
10 sep. 2014

Dernière modification : 17/07/2023

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