ONLINE HELP
 WINDEV, WEBDEV AND WINDEV MOBILE

Version: 2025
Analysis: Description of data file structure
The analysis allows you to define the structure of data files used by the project...
How do I run through a data file?
Looper control linked to a data file
A Looper control can be used to display the content of a data file or query...
Generating a description of a data file from a window or from a page
When you design a quick prototype, you often create windows (or pages) without defining any data files...
Creating an executable: Data file directory
Two types of directories can be configured when creating the executable...
Linking a Table control to a data file or query
A Table control can be used to display the content of a data file or query...
HExportJSONString (Function)
Exports the records from a data file (HFSQL or OLE DB), view or query to a JSON string.
HEndNoModif (Function)
Unlocks a file that was locked by the same program with HNoModif.
<Source>.ListKey (Function)
Returns the list of keys in a data file (query or view) recognized by the HFSQL engine.
HErrorLock (Function)
Used to check whether a lock error occurred.
HDescribeFullTextIndex (Function)
Describes a full-text index of data file created programmatically.
HExportCSV (Function)
Exports the records found in a data file (HFSQL or OLE DB), a view or a query to a CSV file.
Using Unicode in HFSQL data files
The analysis proposes two types of Unicode items...
<Source>.ExportXML (Function)
Exports the records found in a data file (HFSQL or OLE DB), view or query to an XML file.
<Source>.DescribeFile (Function)
Describes a data file programmatically.
<Source>.Read (Function)
Reads a record in a file according to a given record number.
HErrorPassword (Function)
After the execution of a read or write function in a data file, used to find out whether an error caused by a wrong password occurred on this data file.
HClose (Function)
Closes either a data file or all data files opened by the current user: all corresponding physical data files are closed for the current user.
HDescribeFile (Function)
Describes a data file programmatically.
<Source>.ExportCSV (Function)
Exports the records found in a data file (HFSQL or OLE DB), a view or a query to a CSV file.
HGetCurrentPosition (Function)
Returns the approximate position of current record in the data file.
HListStopWord (Function)
Returns the list of stop words used by a full-text index.
HWatchStop (Function)
Stops watching a data file on an HFSQL server.
HRestorePosition (Function)
Restores the previously saved context of a file (function HSavePosition): record in progress, filter, playback pointers.
<Source>.Watch (Function)
Trigger monitoring of write actions (add, modify or delete) performed on a data file present on an HFSQL server. In case of modification, a specific procedure can be triggered.
<Source>.DeleteAll (Function)
Deletes all records from a data file, an HFSQL view or a query.
HNoModif (Function)
Forbids all the modifications on a data file (for all the programs, including the one that requested the no-modification policy).
HDBCreation (Function)
Ends the description of the structure of an xBase data file programmatically.
<Source>.Previous (Function)
Sets the position on the previous record of the data file according to a browse item.
HDescribeItem (Function)
Describes a file item programmatically.
<Source>.Delete (Function)
Deletes a record from a data file (query or view).
HFTListWord (Function)
Lists the words of the current record that will be taken into account by the full-text indexing.
HListSpatialKeys (Function)
Returns the spatial keys of a data file (used in a query or view) recognized by the HFSQL engine.
HUnlockRecNum (Function)
Unlocks a record locked by:
  • HLockRecNum,
  • a read function used with a locking parameter (HRead associated with the hLockWrite or hLockReadWrite constant for example).
Managing connections
WINDEV, WEBDEV and WINDEV Mobile propose different methods for describing a connection...
<Source>.NoModif (Function)
Forbids all the modifications on a data file (for all the programs, including the one that requested the no-modification policy).
<Source>.ExportXLS (Function)
Exports records from a data file (HFSQL or OLE DB), view or query to an Excel file (XLSX).
<Source>.Filter (Function)
Defines and enables a filter on a data file, view or query.
HFirst (Function)
Sets the position on the first record of a data file according to the specified browse item.
HRecordToString (Function)
Converts the content of the current record to string (in a data file, HFSQL view, query, etc.).
<Source>.Open (Function)
Opens a data file.
HDeactivateTrigger (Function)
Disables a trigger.
<Source>.Last (Function)
Sets the position on the last record of a data file according to a browse item.
HRead (Function)
Reads a record in a file according to a given record number.
HReadNext (Function)
Sets the position on the next data file record according to a browse item.
HLast (Function)
Sets the position on the last record of a data file according to a browse item.
<Source>.Write (Function)
Writes a record into a data file without updating the indexes corresponding to all keys used in the file.
HFilter (Function)
Defines and enables a filter on a data file, view or query.
HDelete (Function)
Deletes a record from a data file (query or view).
<Source>.RestorePosition (Function)
Restores the previously saved context of a file (function HSavePosition): record in progress, filter, playback pointers.
HOut (Function)
Used to find out whether the record on which you want to be positioned is located outside the data file, filter, view or query.
HReadLast (Function)
Sets the position on the last record of a data file according to a browse item.
HExportJSON (Function)
Exports the records found in a data file (HFSQL or OLE DB), view or query to a JSON file.
<Source>.CreateView (Function)
Creates an HFSQL view.
This function uses the former view mechanism.
<Source>.GetCurrentPosition (Function)
Returns the approximate position of current record in the data file.
HWatch (Function)
Trigger monitoring of write actions (add, modify or delete) performed on a data file present on an HFSQL server. In case of modification, a specific procedure can be triggered.
<Source>.SavePosition (Function)
Stores the current context of a data file: current record, filter, read pointers.
<Source>.ReadNext (Function)
Sets the position on the next data file record according to a browse item.
HCheckUnaltered (Function)
Checks that one or all records in an unalterable data file have not been modified (e.g. with a hexadecimal editor).
<Source>.ListLink (Function)
Returns the list of links (Merise) in the current analysis or in a specific analysis.
HDeleteAll (Function)
Deletes all records from a data file, an HFSQL view or a query.
<Source>.ListSynonym (Function)
Returns the list of synonyms used by a full-text index.
HListItem (Function)
Returns the list of items:
  • found in a data file ( a query or a view) known to the HFSQL engine. The data files defined by HDeclare, HDeclareExternal and HDescribeFile are taken into account.
  • found in a Record variable.
HCancelAlias (Function)
Cancels an alias that was declared beforehand by HAlias.
HListWatchedFiles (Function)
Returns the list of data files watched by HWatch.
<Source>.ListFullTextIndex (Function)
Returns the list of full-text indexes of a file (a query or a view) recognized by the HFSQL engine.
<Source>.Next (Function)
Sets the position on the next data file record according to a browse item.
Zombie data files and items
During the life of an application, items live and die...
<Source>.First (Function)
Sets the position on the first record of a data file according to the specified browse item.
Unalterable data files
This feature is used to signal that a data file cannot be modified after writing...
HSavePosition (Function)
Stores the current file context (current record, filter, pointers).
HErrorIntegrity (Function)
Used to check whether an integrity error occurred.
<Source>.DeleteView (Function)
Deletes a previously created view. This function uses the former view mechanism.
HRetrieveRecord (Function)
Returns the content of the current record (in a file, a view or a query, ...).
<Source>.DescribeTrigger (Function)
Adds or modifies a trigger on an HFSQL data file.
<Source>.EndNoModif (Function)
Unlocks a file that was locked by the same program with HNoModif.
<Source>.RetrieveRecord (Function)
Returns the content of the current record (in a file, a view or a query, ...).
HListREP (Function)
Returns the list of assignments for the data files handled by the current application, which means the list of physical files corresponding to the files described in the analysis.
HSetPosition (Function)
Sets the position on a record, based on the approximate position of one of its items.
<Source>.FTListWord (Function)
Lists the words of the current record that will be taken into account by the full-text indexing.
<Source>.ListItem (Function)
Returns the list of items in a data file (query or view) recognized by the HFSQL engine. The data files defined by HDeclare, HDeclareExternal and HDescribeFile are taken into account.
<Source>.ReadPrevious (Function)
Sets the position on the previous record of a file according to a browse item.
HReset (Function)
Initializes:
  • one or all variables of file items with their default values.
  • one or all items of a Record variable with their default values.
HDeactivateFilter (Function)
Temporarily disables the filter on a data file (view or query).
HExportXLS (Function)
Exports records from a data file (HFSQL or OLE DB), view or query to an Excel file (XLSX).
HOpen (Function)
Opens a data file.
fDataDir (Function)
Returns the full path of the directory of HFSQL data files specified by the user when installing the application.
<Source>.ExportJSON (Function)
Exports the records found in a data file (HFSQL or OLE DB), view or query to a JSON file.
<Source>.ListStopWord (Function)
Returns the list of stop words used by a full-text index.
HListFullTextIndex (Function)
Returns the list of full-text indexes of a file (a query or a view) recognized by the HFSQL engine.
<Source>.WatchStop (Function)
Stops watching a data file on an HFSQL server.
<Source>.UnlockFile (Function)
Unlocks the records of a data file:
  • locked by HLockFile.
  • individually locked by a locking read function.
HWrite (Function)
Writes a record into a data file without updating the indexes corresponding to all keys used in the file.
<Connection variable>.ListWatchedFiles (Function)
Returns the list of data files watched by HWatch.
HCreateView (Function)
Creates an HFSQL view.
This function uses the former view mechanism.
<Source>.ExportJSONString (Function)
Exports the records from a data file (HFSQL or OLE DB), view or query to a JSON string.
HListLink (Function)
Returns the list of data file bindings (Merise type) present:
  • in the current analysis,
  • in ongoing analyses (projects with multiple analyses).
  • in a specific analysis.
HDeleteView (Function)
Deletes a previously created view. This function uses the former view mechanism.
HListKey (Function)
Returns the list of keys in a data file (query or view) recognized by the HFSQL engine.
<Source>.Reset (Function)
Initializes:
  • one or all variables of file items with their default values.
  • one or all items of a Record variable with their default values.
HDescribeTrigger (Function)
Adds or modifies a trigger on an HFSQL data file.
NULL values in HFSQL
WINDEV, WEBDEV and WINDEV Mobile allow you to manage the NULL value in the items of the HFSQL data files and for all the other types of accesses (Native, OLE DB, ...
HPrevious (Function)
Sets the position on the previous record of the data file according to a browse item.
<Source>.Found (Function)
Checks whether the current record corresponds to the current filter or search.
HFound (Function)
Checks whether the current record corresponds to the current filter or search.
HUnlockFile (Function)
Unlocks the records of a data file:
  • locked by HLockFile.
  • individually locked by a locking read function.
HDescribeLink (Function)
Describes a link between two data files programmatically.
<Source>.ReadLast (Function)
Sets the position on the last record of a data file according to a browse item.
HReadPrevious (Function)
Sets the position on the previous record of a file according to a browse item.
HListSynonym (Function)
Returns the list of synonyms used by a full-text index.
Application triggers
A trigger is a WLanguage procedure automatically called by the HFSQL engine whenever a modification is performed (addition, deletion, modification, ...) on a record of a data file.
<Source>.DeactivateFilter (Function)
Temporarily disables the filter on a data file (view or query).
<Source>.CheckUnaltered (Function)
Checks that one or all records in an unalterable data file have not been modified (e.g. with a hexadecimal editor).
HListFile (Function)
Returns the list of files:
  • current analysis.
  • analyses in progress (projects with multiple analyses).
  • a specific analysis recognized by the HFSQL engine.
  • available on a connection via a Native Connector or an OLE DB driver.
  • for a group of files defined in the data model editor.
<Source>.Close (Function)
Closes either a data file or all data files opened by the current user: all corresponding physical data files are closed for the current user.
<Source>.Out (Function)
Allows you to find out whether the record on which you want to be positioned is located outside the data file, filter, view or query.
<Source>.RecordToString (Function)
Converts the content of the current record to string (in a data file, HFSQL view, query, etc.).
<Source>.UnlockRecNum (Function)
Unlocks a record locked by:
  • HLockRecNum,
  • a read function used with a locking parameter (HRead associated with the hLockWrite or hLockReadWrite constant for example).
HExportXML (Function)
Exports the records found in a data file (HFSQL or OLE DB), view or query to an XML file.
<Source>.ListSpatialKeys (Function)
Returns the spatial keys of a data file (used in a query or view) recognized by the HFSQL engine.
<Source>.SetPosition (Function)
Sets the position on a record, based on the approximate position of one of its items.
HNext (Function)
Sets the position on the next data file record according to a browse item.
HDescribeItem (Example)
Usage example of the HDescribeItem function
StoredItem (Property)
The StoredItem property is used to: Find out the stored item or the stored variable of a Table, Looper, List Box or Combo Box control. Modify the stored item or the stored variable of a Table, Looper, List Box or Combo Box control....
Size (Example)
Usage example of the Size property
NbThumbnail (Property)
The NbThumbnail property is used to get the number of thumbnails generated for an item.
Running the test of the User Groupware and installing it
NullableIndex (Property)
The NullIableIndex property determines if a key item supports the "Null" value.
1. Implementing a Client/Server database
WEBDEV Tutorial - Managing an HFSQL Client/Server database Lesson 1 - Implementing a Client/Server database - 10 min...
Composite keys
A composite key is a key item containing several other items......
HDescribeConnection (Function)
Describes a new connection to an external database.
Customizing the User Groupware
TableAdd (Function)
Adds a row in: a Table control, a TreeView Table control, a Combo Box control "with table" (Table control displayed in a Combo Box control)....
2. Managing a Client/Server database
WEBDEV Tutorial - Managing an HFSQL Client/Server database Lesson 2 - Managing a Client/Server database - 20 min...
InfoThumbnailGeneration (Property)
The InfoThumbnailGeneration property is used to determine if the thumbnails of an item have been generated successfully.
2. Managing a Client/Server database
WINDEV Tutorial: Using an HFSQL Client/Server database Lesson 2 - Managing a Client/Server database - 20 min...
HLockRecNum (Function)
Locks a record and restricts the access to this record for all the other applications.
Constants used by ExecutePresetAction
List of constants used by ExecutePresetAction....
12. Retrieving data from a site
Native Access Connector
This type of Native Connector allows access to ACCESS databases for better interoperability purposes......
LooperDelete (Function)
Deletes a row from a Looper control.
Android application: Using and sharing SQLite data
For the Android applications, the available databases are HFSQL (Classic and Client/Server) and SQLite....
HCopyRecord (Example)
Usage example of the HCopyRecord function
H.NumRec (Variable)
Contains the number of the physical record loaded in memory (which means the number of the last record read).
1
…
35
36
37
38
39
…
216
>