- How to describe a data file through programming?
- List of HFSQL properties used to describe a data file through programming
- Types of data files that can be described with the HDescribeFile function
- Syntax 2: Description of data file (compatibility with 5.5)
HDescribeFile (Function) In french: HDécritFichier
 Not available with this kind of connection
// Exemple utilisant la syntaxe 1
UnFichier is File Description
UneRubrique is Item Description
Client is Data Source = "Client"
// Description du fichier de données "Client"
UnFichier.Name = "Client"
UnFichier.Type = hFileNormal
UnFichier.FicCryptMethod = hEncryptionStandard
// Description de la rubrique "Nom"
UneRubrique.Name = "NOM"
UneRubrique.Type = hItemText
UneRubrique.Size = 40
UneRubrique.KeyType = hUniqueKey
HDescribeItem(UnFichier, UneRubrique)
// Description de la rubrique "Prénom"
UneRubrique.Name = "PRENOM"
UneRubrique.Type = hItemText
UneRubrique.Size = 40
HDescribeItem(UnFichier, UneRubrique)
// Valide la description du fichier de données
HDescribeFile(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é"
HAdd(Client)
// Exemple utilisant la syntaxe 2
UneDescriptionFichier is File Description
UneRubrique is Item Description
sdSource is Data Source
// Description du fichier de données "CLIENT"
UneDescriptionFichier.Name = "CLIENT"
UneDescriptionFichier.Type = hFileNormal
UneDescriptionFichier.FicCryptMethod = hEncryptionStandard
// Description de la rubrique "NOM"
UneRubrique.Name = "NOM"
UneRubrique.Type = hItemText
UneRubrique.Size = 40
UneRubrique.KeyType = hUniqueKey
HDescribeItem(UneDescriptionFichier, UneRubrique)
// Description de la rubrique "PRENOM"
UneRubrique.Name = "PRENOM"
UneRubrique.Type = hItemText
UneRubrique.Size = 40
HDescribeItem(UneDescriptionFichier, UneRubrique)
// Valide la description du fichier de données
HDescribeFile(sdSource, UneDescriptionFichier)
HCréation(sdSource)
Syntax
Describing a data file through programming Hide the details
<Result> = HDescribeFile(<Data file>)
<Result>: Boolean - True if the description of the data file is valid and if it can be used,
- False if a problem occurred. HErrorInfo is used to identify the error.
<Data file>: File Description variable Name of the Variable of type File Description (see paragraph Notes) to describe the data file. The name of the data file will be defined by the Property nom.
Describing a data file through programming using a data source Hide the details
<Result> = HDescribeFile(<Data source> , <Data file>)
<Result>: Boolean - True if the description of the data file is valid and if it can be used,
- False if a problem occurred. HErrorInfo is used to identify the error.
<Data source>: Data Source variable Name of the Data source variable associated with the data file. <Data file>: File Description variable Name of the Variable of type File Description (see paragraph Notes) to describe the data file. The name of the data file will be defined by the Property nom. Remarks How to describe a data file through programming? To describe a data file through programming, you must: - Solution 1 (syntax 1): Direct description
- Use the File Description, Item Description, Link description and FullTextIndex description variables (if necessary).
- Describe the characteristics of the data file, items, links and full-text indexes (if necessary) via the HFSQL properties.
- Define the description of items with HDescribeItem.
- Define the description of full-text indexes with HDescribeFullTextIndex.
- Define the description of the data file (HDescribeFile) and links if necessary (HDescribeLink).
 Versions 24 and laterSolution 2 (syntax 2): Description using a data sourceThis solution allows associating the data file described to a data source. In this case, when this variable is deleted, the data file will also be deleted. Caution: To use this syntax, you must use an "automatic" data source. For more details, see Project description: Compilation tab. - Declare a variable of type Data source.
- Use the File Description, Item Description, Link description and FullTextIndex description variables (if necessary).
- Describe the characteristics of the data file, items, links and full-text indexes (if necessary) via the HFSQL properties.
- Define the description of items with HDescribeItem.
- Define the description of full-text indexes with HDescribeFullTextIndex.
- Associate the data file description with the data source (HDescribeFile, syntax 2) and links if necessary (HDescribeLink).
 New in version 24Solution 2 (syntax 2): Description using a data sourceThis solution allows associating the data file described to a data source. In this case, when this variable is deleted, the data file will also be deleted. Caution: To use this syntax, you must use an "automatic" data source. For more details, see Project description: Compilation tab. - Declare a variable of type Data source.
- Use the File Description, Item Description, Link description and FullTextIndex description variables (if necessary).
- Describe the characteristics of the data file, items, links and full-text indexes (if necessary) via the HFSQL properties.
- Define the description of items with HDescribeItem.
- Define the description of full-text indexes with HDescribeFullTextIndex.
- Associate the data file description with the data source (HDescribeFile, syntax 2) and links if necessary (HDescribeLink).
This solution allows associating the data file described to a data source. In this case, when this variable is deleted, the data file will also be deleted.
Caution: To use this syntax, you must use an "automatic" data source. For more details, see Project description: Compilation tab. - Declare a variable of type Data source.
- Use the File Description, Item Description, Link description and FullTextIndex description variables (if necessary).
- Describe the characteristics of the data file, items, links and full-text indexes (if necessary) via the HFSQL properties.
- Define the description of items with HDescribeItem.
- Define the description of full-text indexes with HDescribeFullTextIndex.
- Associate the data file description with the data source (HDescribeFile, syntax 2) and links if necessary (HDescribeLink).
List of HFSQL properties used to describe a data file through programming The following properties are available in read/write mode.
| | | CtAccess | The CtAccess property is used to set the type of access to the data file when connecting to a specific table via OLE DB. | | CtDatabase | The CtDatabase property is used to set the OLE DB data source when connecting to a specific table via OLE DB. | | CtDescribedAccess | The CtDescribedAccess property is used to set the type of access to the data file when connecting to a specific table via OLE DB. | | CtDescribedCaption | The CtDescribedCaption property is used to get and set the caption of the connection to the OLE DB data source. | | CtDescribedDatabase | The CtDescribedDatabase property is used to set the OLE DB data source when connecting to a specific table via OLE DB. | | CtDescribedOLEDBProvider | The CtDescribedOLEDBProvider property is used to get and set the name of the OLE DB provider (also called OLE DB server). | | CtDescribedPassword | The CtDescribedPassword property allows you to set the password used to open the data file in an OLE DB connection (file defined in the code only). | | CtDescribedUserName | The CtDescribedUserName property is used to set the username that will be used when connecting to a specific table via OLE DB. | | CtOLEDBProvider | The CtOLEDBProvider property is used to get and set the name of the OLE DB provider (also called OLE DB server). | | CtUserName | The CtUserName property is used to set the username that will be used when connecting to a specific table via OLE DB. | | DescribedDirectory | The DescribedDirectory property is used to manage the physical directory of HFSQL files. | | DescribedName | The DescribedName property is used to handle the logical name of HFSQL data files (ignoring possible changes made by HAlias). | | DescribedPhysicalName | The DescribedPhysicalName property is used to manage the physical name of HFSQL data files. | | Directory | The Directory property is used to manage the physical directory of HFSQL files. | | FicCryptMethod | The FicCryptMethod property is used to set the encryption method of a data file. | | Format | The Format property is used to define the data format of a data file. | | HugeFile | The HugeFile property is used to configure the maximum size of a data file. | | LogDirectory | The LogDirectory property is used to manage the directory of the log file described in the analysis. | | LogMethod | The LogMethod property is used to:- find out the log mode used for a data file (file defined in the data model editor or through programming).
- define the log mode used for a data file (when the file is described through programming).
| | MmoCryptMethod | The MmoCryptMethod property is used to set the encryption method of the memo file (.MMO) associated with the data file. | | MmoPackMethod | The MmoPackMethod property is used to set the compression mode of the MMO file (containing text and binary memos) associated with the data file. | | Name | The Name property is used to get:- the name of the font associated with a Font variable.
- the name of a control, report or report block.
- the name of a control, group of controls or window.
- the name of a control, group of controls or page.
| | Name55 | The Name55 property is used to manipulate the logical name of a Hyper File 5.5 data file that has not been migrated and is located in a WINDEV 19 analysis. | | NdxCryptMethod | The NdxCryptMethod property is used to configure the encryption method for the index (.NDX) file associated with the data file. | | PhysicalName | The PhysicalName property is used to manage the physical name of HFSQL data files. | | Secure | The Secure property is used to configure the security level of data file encryption. | | TextItemCompleted | The TextItemCompleted property is used to manage text items in an HFSQL data file. | | Type | The Type property is used to get:- the type of element described through programming (file or item description) or not (file or item defined in the data model editor, view or query).
- the type of object.
- the type of value stored in a variant.
| | WDD55 | WDD55 is used to:- Find out the name and full path of the WDD file in Hyper File 5.5 format.
- Define the name and full path of the WDD file in Hyper File 5.5 format.
| | WDD55Password | The WDD55Password property is used to specify the password of the 5.5 analysis that contains a Hyper File 5.5 data file used in an HFSQL Classic analysis. |
Types of data files that can be described with the HDescribeFile function Type is used to specify the type of data file to create. The following types can be created with function HDescribeFile: | | | hFileAS400 | AS400 file | | hFileNormal | Standard file | | hFileOLEDB | OLE DB file | | hFileOracle | Oracle file | Versions 16 and laterhFileSQLAzure New in version 16hFileSQLAzure hFileSQLAzure | SQL Azure file | | hFileSQLServer | SQL Server file | | hFileSybase | Sybase file | | hFileXBase | xBase file |
Business / UI classification: Business Logic
This page is also available for…
|
|
|