ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Version: 2025

Category: HFSQL functions
382 results
<Connection variable>.CloseConnection (Function)
Closes a connection to a database.
<Connection variable>.FileExist (Function)
Finds out if a file exists, i.e. if it has been physically created (HCreate or HCreationIfNotFound).
<Connection variable>.InfoFile (Function)
Returns the characteristics of an HFSQL Classic or Client/Server table.
<Connection variable>.OpenConnection (Function)
Opens a connection to a specific database.
<Connection variable>.RefreshView (Function)
Asks to recalculate the content of a materialized view.
<Connection variable>.RegenerateFile (Function)
Regenerates a table from its log.
<Connection variable>.SetIntegrity (Function)
Enables or disables the management of an integrity constraint on a file link.
<Connection variable>.Transaction (Function)
Starts a transaction on the tables (HFSQL or accessed via Native Access) and creates the transaction table.
<Connection variable>.TransactionCancel (Function)
If a transaction is in progress, rolls back all operations performed on tables in transactions since the start of the transaction.
<Connection variable>.TransactionEnd (Function)
Validates the current transaction:
  • the modifications performed on the table since the start of transaction (HTransactionStart) are validated.
  • the transaction file is deleted (if the transaction is the last transaction in progress for a network application)
  • the records locked in read-only by the transaction are unlocked.
<Connection variable>.TransactionStart (Function)
Starts a transaction on the tables (HFSQL or accessed via Native Access) and creates the transaction table.
<Destination>.CopyRecord (Function)
Copies:
  • the content of the current record (loaded in memory) to the current table record.
  • the content of the Record variable to the current table record.
<Source>.ActivateAutoFilter (Function)
Enables an automatic filter on the linked files when browsing an XML file.
<Source>.ActivateFilter (Function)
Enables the filter that was previously created for the specified table (view or query).
<Source>.Add (Function)
Adds:
  • the record found in memory into the table (query or view).
  • the record found in a Record variable into the table (query or view).
<Source>.Alias (Function)
Creates a logical alias of a table (or query) or cancels all existing aliases.
<Source>.Backward (Function)
Moves backward several records from the current position in the table, according to a specified item.
<Source>.BuildKeyValue (Function)
Builds the value of a composite key to implement a filter (HFilter) or to perform a search (HReadSeekFirst, HReadSeekLast, etc.).
<Source>.CancelDeclaration (Function)
Allows you to:
<Source>.CancelSeek (Function)
Cancels the current search criterion.
<Source>.ChangeConnection (Function)
Dynamically changes the connection associated with a table.
<Source>.ChangeDir (Function)
Changes the path to a table (i.e. directory in which the file will be handled).
<Source>.ChangeKey (Function)
Changes the browse item.
<Source>.ChangeLocation (Function)
Modifies the search mode of physical tables (.FIC, .NDX, ...).
<Source>.ChangeLogDir (Function)
Modifies the location of log files corresponding to an HFSQL table.
<Source>.ChangeName (Function)
Modifies the physical name of a table.
<Source>.CheckIndex (Function)
Checks whether the data found in the index table (.NDX file) properly refers the data found in the table (.FIC file).
<Source>.CheckMemo (Function)
Checks the structural integrity of memos in an HFSQL table.
<Source>.CheckStructure (Function)
Defines the mode for comparing tables.
<Source>.CheckUnaltered (Function)
Checks that one or all records in an unalterable table have not been modified (e.g. with a hexadecimal editor).
<Source>.Close (Function)
Closes either a table or all tables opened by the current user: all corresponding physical tables are closed for the current user.
<Source>.CompareItem (Function)
Compares two values by sorting them according to the specified HFSQL index sort item: all sort options specified for the sort item are taken into account (case sensitivity, punctuation, sort direction, Unicode language, ...).
<Source>.CreateIfNotFound (Function)
Performs the following operations:
  • If the table doesn't exist, create an empty table (file with ".FIC" extension) with the index file, the full-text index file and the memo file if necessary. The function is equivalent to HCreation.
  • If the table exists, opens the table.
<Source>.CreateView (Function)
Creates an HFSQL view.
This function uses the former view mechanism.
<Source>.Creation (Function)
Creates an empty table (extension ".FIC") with index file, full-text index file, spatial index file, and memo file if required.
<Source>.Cross (Function)
Crosses a record in a table.
<Source>.DataSourceKnown (Function)
Determines if a data source has been initialized.
<Source>.DeactivateAutoFilter (Function)
Disables an automatic filter on the linked files when browsing an XML file.
<Source>.DeactivateFilter (Function)
Temporarily disables the filter on a table (view or query).
<Source>.Declare (Function)
Declares a description of table (found in a database schema) in the current project.
<Source>.DeclareExternal (Function)
Temporarily imports into the current database schema the description of a table from an existing HFSQL table.
<Source>.Delete (Function)
Deletes a record from a table (query or view).
<Source>.DeleteAll (Function)
Deletes all records from a table, an HFSQL view or a query.
<Source>.DeleteTrigger (Function)
Deletes a trigger.
<Source>.DeleteView (Function)
Deletes a previously created view. This function uses the former view mechanism.
<Source>.DescribeFile (Function)
Describes a table programmatically.
<Source>.DescribeTrigger (Function)
Adds or modifies a trigger on an HFSQL table.
<Source>.DuplicateRecord (Function)
Duplicates the record read in a table: the record found in memory is added into the table (query or view).
<Source>.EndNoModif (Function)
Unlocks a file that was locked by the same program with HNoModif.
<Source>.ErrorModification (Function)
Returns the value of a record item when a modification conflict occurs..
<Source>.ErrorStatusModification (Function)
Returns the status of a record during a modification conflict.
<Source>.ExecuteQuery (Function)
Declares a query created in the query editor to the HFSQL engine and runs this query.
<Source>.ExecuteQueryAsynchronous (Function)
Executes a SELECT query asynchronously.
<Source>.ExecuteSQLQuery (Function)
Initializes a query written in SQL language and declares this query to the HFSQL engine.
<Source>.ExecuteSQLQueryAsynchronous (Function)
Executes an SQL query asynchronously.
<Source>.ExecuteView (Function)
Runs a view that was created beforehand (can be used to refresh the view data for example). This function uses the former view mechanism.
<Source>.ExportCSV (Function)
Exports the records found in a table (HFSQL or OLE DB), a view or a query to a CSV file.
<Source>.ExportJSON (Function)
Exports the records found in a table (HFSQL or OLE DB), view or query to a JSON file.
<Source>ExportJSON String (Function)
Exports the records from a table (HFSQL or OLE DB), view, or query to a JSON string.
<Source>.ExportXLS (Function)
Exports records from a table (HFSQL or OLE DB), view or query to an Excel file (XLSX).
<Source>.ExportXML (Function)
Exports the records found in a table (HFSQL or OLE DB), view or query to an XML file.
<Source>.ExtractMemo (Function)
Extracts the content of a binary memo item from an HFSQL table, from a query or from an HFSQL view into a physical file (on disk).
<Source>.FileExist (Function)
Determines:
  • whether a file exists, which means whether it was physically created (HCreation or HCreationIfNotFound).
  • whether a view or a query was defined.
<Source>.Filter (Function)
Defines and enables a filter on a table, view or query.
<Source>.FilterContains (Function)
Defines and enables a "Contains" filter on a table, view or query.
<Source>.FilterIdentical (Function)
Defines and enables a filter used to find the exact value of a string item.
<Source>.FilterIncludedBetween (Function)
Defines and enables an "Included between" filter on a file, view or query.
<Source>.FilterStartsWith (Function)
Defines and enables a "Start with" filter on a file, view or query.
<Source>.First (Function)
Sets the position on the first record of a table according to the specified browse item.
<Source>.Flush (Function)
Forces the operating system of the computer where the tables are found to write data onto the disk.
<Source>.Forward (Function)
Moves several records forward from the current position in the table, according to a specified item.
<Source>.Found (Function)
Checks whether the current record corresponds to the current filter or search.
<Source>.Free (Function)
Transforms the crossed records (HCross) into deleted records.
<Source>.FreeQuery (Function)
Releases query resources (following use of HExecuteQuery or HExecuteSQLQuery functions).
<Source>.FTListWord (Function)
Lists the words of the current record that will be taken into account by the full-text indexing.
<Source>.GetCurrentPosition (Function)
Returns the approximate position of current record in the table.
<Source>.HistoryModification (Function)
Returns the modifications performed on one or more items of a given record. The result can be displayed in a list box or in a table to allow the user to view the modifications made to the specified file.
<Source>.ImportCSV (Function)
Imports a CSV file into an HFSQL Classic or Client/Server table. This table must have been defined in the data model editor, or declared with HDeclare, HDeclareExternal or HDescribeFile).
<Source>.ImportHF55 (Function)
Imports a Hyper File 5.5 file into an HFSQL Classic file.
<Source>.ImportJSON (Function)
Imports a JSON file into an HFSQL Classic table. This table must have been defined in the data model editor, or declared with HDeclare, HDeclareExternal or HDescribeFile).
<Source>.ImportText (Function)
Imports a Text file into an HFSQL Classic or Client/Server table. This table must have been defined in the data model editor, or declared with HDeclare, HDeclareExternal or HDescribeFile).
<Source>.ImportXLS (Function)
Imports an XLS file into an HFSQL Classic or Client/Server table. This table must have been defined in the data model editor, or declared with HDeclare, HDeclareExternal or HDescribeFile).
<Source>.ImportXML (Function)
Imports an XML file into an HFSQL Classic or Client/Server table. This table must have been defined in the data model editor, or declared with HDeclare, HDeclareExternal or HDescribeFile).
<Source>.Index (Function)
Rebuilds the file index (".NDX" file).
<Source>.IndexingInProgress (Function)
Indicates that a reindex operation is currently performed on an HFSQL table and returns the percentage of reindexing already performed.
<Source>.InfoFile (Function)
Returns the characteristics of an HFSQL Classic or Client/Server table.
<Source>.InfoMemo (Function)
Returns the characteristics of binary and text memos.
<Source>.InitSubscriber (Function)
Initializes the range of automatic identifiers for the description file of subscriber replica (".RPL" extension).
<Source>.JSONToRecord (Function)
Imports JSON data into the current record.
<Source>.Last (Function)
Sets the position on the last record of a table according to a browse item.
<Source>.LinkMemo (Function)
Used to associate a file with a binary memo item or to cancel the existing link between a file and a binary item.
<Source>.ListFullTextIndex (Function)
Returns the list of full-text indexes of a file (a query or a view) recognized by the HFSQL engine.
<Source>.ListItem (Function)
Returns the list of items in a table (query or view) recognized by the HFSQL engine. The tables defined by HDeclare, HDeclareExternal and HDescribeFile are taken into account.
<Source>.ListKey (Function)
Returns the list of keys in a table (query or view) recognized by the HFSQL engine.
<Source>.ListLink (Function)
Returns the list of links (Merise) in the current database schema or in a specific database schema.
<Source>.ListQueryParameter (Function)
Returns the list of parameters for a query created in the query editor.
<Source>.ListSpatialKeys (Function)
Returns the spatial keys of a table (used in a query or view) recognized by the HFSQL engine.
<Source>.ListStopWord (Function)
Returns the list of stop words used by a full-text index.
<Source>.ListSynonym (Function)
Returns the list of synonyms used by a full-text index.
<Source>.LockFile (Function)
Locks a table and restricts the access to this table for all other sites or applications.
<Source>.LockRecNum (Function)
Locks a record and restricts the access to this record for all the other applications.
<Source>.LogInfo (Function)
Adds comments to the log when saving the operation.
<Source>.LogRecreate (Function)
Used to recreate an empty log.
<Source>.LogRestart (Function)
Restarts the logging process on a file.
<Source>.LogStop (Function)
Stops the log process of a file.
<Source>.MergeView (Function)
Creates an HFSQL view from two previously created views (HCreateView). This function uses the former view mechanism.
<Source>.MigrateLinkedCompositeKey (Function)
Migrates the values of the linked composite keys coming from a file in Hyper File 5.5 format to the HFSQL Classic format.
<Source>.Mode (Function)
Changes the mode and the method for locking tables.
<Source>.Modify (Function)
Modifies the specified record or the record found in memory in the table (query or view).
<Source>.ModifyStructure (Function)
Used to update the structure of an HFSQL table by performing an automatic data modification (also called data synchronization).
<Source>.NbRec (Function)
Returns the number of records in an HFSQL file, query or view: active records, deleted records, etc.
<Source>.Next (Function)
Sets the position on the next table record according to a browse item.
<Source>.NoModif (Function)
Forbids all the modifications on a table (for all the programs, including the one that requested the no-modification policy).
<Source>.OnError (Function)
Customizes the management of HFSQL errors.
<Source>.Open (Function)
Opens a table.
<Source>.Optimize (Function)
Used to handle the idle periods of a software (period without processes) to optimize the queries and the browses that will be run thereafter.
<Source>.Out (Function)
Allows you to find out whether the record on which you want to be positioned is located outside the table, filter, view or query.
<Source>.Password (Function)
Defines the password used to create or open a table.
<Source>.PrepareQuery (Function)
Initializes a query and declares this query to the database server in order to optimize the next executions of this query.
<Source>.PrepareSQLQuery (Function)
Initializes a query written in SQL language and declares this query to the database server in order to optimize the next executions of this query.
<Source>.Previous (Function)
Sets the position on the previous record of the table according to a browse item.
<Source>.QueryExecuted (Function)
Determines if a query has been executed.
<Source>.Read (Function)
Reads a record in a file according to a given record number.
<Source>.ReadFirst (Function)
Sets the position on the first record according to a browse item.
<Source>.ReadLast (Function)
Sets the position on the last record of a table according to a browse item.
<Source>.ReadNext (Function)
Sets the position on the next table record according to a browse item.
<Source>.ReadPrevious (Function)
Sets the position on the previous record of a file according to a browse item.
<Source>.ReadSeek (Function)
Sets the position on the first record whose value for a specific item is greater than or equal to a sought value (generic search).
<Source>.ReadSeekFirst (Function)
Sets the position on the first record whose value for a specific item is strictly equal to a sought value (exact-match search).
<Source>.ReadSeekLast (Function)
Sets the position on the last record whose value for a specific item is less than or equal to a sought value (exact-match search).
<Source>.RecNum (Function)
Returns:
  • the number of the current record in the HFSQL table.
  • the number of the current record in the HFSQL view.
<Source>.RecordDate (Function)
Returns the date and time of last write operation performed on a record in an HFSQL table (Classic or Client/Server).
<Source>.RecordToJSON (Function)
Retrieves the structure and value of the current record and exports them into a string in JASON format.
<Source>.RecordToString (Function)
Converts the content of the current record to string (in a table, HFSQL view, query, etc.).
<Source>.RecordToXML (Function)
Retrieves the structure and the value of the current record and exports them into a character string in XML format.
<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.
<Source>.RestorePosition (Function)
Restores the previously saved context of a file (function HSavePosition): record in progress, filter, playback pointers.
<Source>.RetrieveItem (Function)
Returns the content of an item found in the current record (in the table, view, query, ...).
<Source>.RetrieveRecord (Function)
Returns the content of the current record (in a file, a view or a query, ...).
<Source>.Save (Function)
Modifies the current record if it exists, otherwise adds a new record.
<Source>.SavePosition (Function)
Stores the current context of a table: current record, filter, read pointers.
<Source>.Security (Function)
Enables or disables the automatic security mechanism on one or more tables.
<Source>.Seek (Function)
Positions on the first record of the table whose value for a specific item is greater than or equal to a search value (generic search by default).
<Source>.SeekFirst (Function)
Positions on the first file record whose value for a specific item is greater than or equal to a sought value.
<Source>.SeekLast (Function)
Sets the position on the last file record whose value for a specific item is less than or equal to a sought value.
<Source>.SetDuplicates (Function)
Enables or disables the management of duplicates on a unique key.
<Source>.SetLog (Function)
Enables or disables log management on a file.
<Source>.SetMemo (Function)
Used to modify the management mode of memo items.
<Source>.SetPosition (Function)
Sets the position on a record, based on the approximate position of one of its items.
<Source>.SetTransaction (Function)
Enables or disables the management of transactions for one or more files.
<Source>.SortView (Function)
Sorts an HFSQL view by creating an index on a view item. This function uses the former view mechanism.
<Source>.StatCalculate (Function)
Performs various statistical calculations on the file keys.
<Source>.StatDate (Function)
Returns the date of the last update for the index statistics.
<Source>.State (Function)
Used to find out the state of a record.
<Source>.StatNbDuplicates (Function)
Returns the number of duplicates for a given key item.
<Source>.StatNbRec (Function)
Returns the number of entries for a given key item.
<Source>.StatNbRecRange (Function)
Returns an estimate regarding the number of entries for a given key item in a given interval of values.
<Source>.StatTime (Function)
Returns the time of the last update for the index statistics.
<Source>.ToFile (Function)
Copies a data source (file, query, view, ...) to a physical HFSQL table with the same description. This table is neither encrypted nor password protected.
<Source>.ToItem (Function)
Assigns the specified value to an item of the current record.
<Source>.TransactionFree (Function)
Transforms all "in transaction" records into "Normal" records if they do not belong to an ongoing transaction.
<Source>.UnlockFile (Function)
Unlocks the records of a table:
  • locked by HLockFile.
  • individually locked by a locking read function.
<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).
<Source>.Version (Function)
Used to find out:
  • whether the content of a file was modified.
  • whether the content of a file used by a query was modified.
<Source>.ViewToFile (Function)
Saves the modifications performed in an HFSQL view (by HModify, HDelete or HCross) in the corresponding table. This function uses the former view mechanism.
<Source>.Write (Function)
Writes a record into a table without updating the indexes corresponding to all keys used in the table.
Convert (Function)
Converts a numeric value into a binary string in order to perform a search on a numeric key.
HAccelerateSpeed (Function)
Reorganizes the internal structure of the indexes to optimize the speed for accessing the data.
HActivateAutoFilter (Function)
Enables an automatic filter on the linked files when browsing an XML file.
HActivateFilter (Function)
Enables the filter that was previously created for the specified table (view or query).
HAdd (Example)
Usage example of the HAdd function
HAdd (Function)
Adds:
  • the record found in memory into the table (query or view).
  • the record found in a Record variable into the table (query or view).
HAlias (Function)
Creates a logical alias of a table (or query) or cancels all existing aliases.
HBackward (Function)
Moves backward several records from the current position in the table, according to a specified item.
HBuildKeyValue (Function)
Builds the value of a composite key to implement a filter (HFilter) or to perform a search (HReadSeekFirst, HReadSeekLast, etc.).
HBuildKeyValueANSI (Function)
Whatever the platform used, the data stored in HFSQL tables is in ANSI format.
HCancelAlias (Function)
Cancels an alias that was declared beforehand by HAlias.
HCancelDeclaration (Example)
Usage example of the HCancelDeclaration function
HCancelDeclaration (Function)
Allows you to:
HCancelSeek (Function)
Cancels the current search criterion.
HChangeConnection (Example)
Usage example of the HChangeConnection function
HChangeConnection (Function)
Dynamically changes the connection associated with a table.
HChangeDir (Function)
Changes the path to a table (i.e. directory in which the file will be handled).
HChangeKey (Function)
Changes the browse item.
HChangeLocation (Function)
Modifies the search mode of physical tables (.FIC, .NDX, ...).
HChangeLogDir (Function)
Modifies the location of log files corresponding to an HFSQL table.
HChangeName (Function)
Modifies the physical name of a table.
HChangeRplDir (Function)
Changes the location of the subscriber replica description ("*.rpl" file).
HCheckIndex (Function)
Checks whether the data found in the index table (.NDX file) properly refers the data found in the table (.FIC file).
HCheckMemo (Function)
Checks the structural integrity of memos in an HFSQL table.
HCheckStructure (Function)
Defines the mode for comparing tables.
HCheckUnaltered (Function)
Checks that one or all records in an unalterable table have not been modified (e.g. with a hexadecimal editor).
HClose (Function)
Closes either a table or all tables opened by the current user: all corresponding physical tables are closed for the current user.
HCloseAnalysis (Function)
Closes the current database schema (or all current database schemas in the case of a project with multiple database schemas).
HCloseConnection (Function)
Closes a connection to a database.
HCompareItem (Function)
Compares two values by sorting them according to the specified HFSQL index sort item: all sort options specified for the sort item are taken into account (case sensitivity, punctuation, sort direction, Unicode language, ...).
HComputer (Function)
Stores a unique computer number or identifier in order to use the log and transactions over the network.
HConnect (Function)
Redefines one or more connection parameters via Native Connector (Access, SQL Server, MySQL or Oracle) or via an OLE DB access on a specific table or set of tables.
HConvertX (Function)
Converts a numeric value into a binary string in order to perform a search on a numeric key.
HCopyRecord (Function)
Copies:
  • the content of the current record (loaded in memory) to the current table record.
  • the content of the Record variable to the current table record.
HCreateMasterReplica (Function)
Creates the description file of a Master Replica (logged replication or universal replication).
HCreateMovableReplica (Function)
Creates a movable replication.
HCreateSubscriberReplica (Function)
Creates the description file of a subscriber replica.
HCreateView (Example)
Usage example of the HCreateView function
HCreateView (Function)
Creates an HFSQL view.
This function uses the former view mechanism.
HCreation (Example)
Usage example of the HCreation function
HCreation (Function)
Creates an empty table (file extension ".FIC") with index file, full-text index file and memo file if required.
HCreationIfNotFound (Example)
Usage example of the HCreationIfNotFound function
HCreationIfNotFound (Function)
Performs the following operations:
  • If the table doesn't exist, create an empty table (file with ".FIC" extension) with the index file, the full-text index file and the memo file if necessary. The function is equivalent to HCreation.
  • If the table exists, opens the table.
HCross (Function)
Crosses a record in a table.
HDataSourceKnown (Function)
Determines if a data source has been initialized.
HDeactivateAutoFilter (Function)
Disables an automatic filter on the linked files when browsing an XML file.
HDeactivateFilter (Function)
Temporarily disables the filter on a table (view or query).
HDeclare (Function)
Declares a description of table (found in a database schema) in the current project.
HDeclareExternal (Example)
Usage example of the HDeclareExternal function
HDeclareExternal (Function)
Temporarily imports into the current database schema the description of a table from an existing HFSQL table.
HDelete (Function)
Deletes a record from a table (query or view).
HDeleteAll (Function)
Deletes all records from a table, an HFSQL view or a query.
HDeleteView (Function)
Deletes a previously created view. This function uses the former view mechanism.
HDescribeConnection (Example)
Usage example of the HDescribeConnection function
HDescribeConnection (Function)
Describes a new connection to an external database.
HDescribeFile (Function)
Describes a table programmatically.
HDescribeFullTextIndex (Example)
Usage example of the HDescribeFullTextIndex function
HDescribeFullTextIndex (Function)
Describes a full-text index of table created programmatically.
HDescribeItem (Example)
Usage example of the HDescribeItem function
HDescribeItem (Function)
Describes a file item programmatically.
HDescribeLink (Function)
Describes a link between two tables programmatically.
HDuplicateRecord (Function)
Duplicates the record read in a table: the record found in memory is added into the table (query or view).
HEndNoModif (Function)
Unlocks a file that was locked by the same program with HNoModif.
HError (Function)
Returns the number of the last error triggered by the HFSQL engine.
HErrorDuplicates (Function)
Used to check whether a duplicate error occurred.
HErrorInfo (Function)
Returns a detailed information about the last error triggered by the HFSQL engine.
HErrorIntegrity (Function)
Used to check whether an integrity error occurred.
HErrorLock (Function)
Used to check whether a lock error occurred.
HErrorModification (Function)
Allows you to:
  • return the value of a record item if a modification conflict occurs.
  • check if a modification conflict occurred.
HErrorPassword (Function)
After the execution of a read or write function in a table, used to find out whether an error caused by a wrong password occurred on this table.
HErrorStatusModification (Function)
Returns the status of a record during a modification conflict.
HExecuteQuery (Function)
Declares a query created in the query editor to the HFSQL engine and runs this query.
HExecuteQueryAsynchronous (Function)
Executes a SELECT query asynchronously.
HExecuteSQLQuery (Function)
Initializes a query written in SQL language and declares this query to the HFSQL engine.
HExecuteSQLQueryAsynchronous (Function)
Executes an SQL query asynchronously.
HExecuteView (Function)
Runs a view that was created beforehand (can be used to refresh the view data for example). This function uses the former view mechanism.
HExportCSV (Function)
Exports the records found in a table (HFSQL or OLE DB), a view or a query to a CSV file.
HExportJSON (Function)
Exports the records found in a table (HFSQL or OLE DB), view or query to a JSON file.
HExportJSONString (Function)
Exports the records from a table (HFSQL or OLE DB), view, or query to a JSON string.
HExportXLS (Function)
Exports records from a table (HFSQL or OLE DB), view or query to an Excel file (XLSX).
HExportXML (Function)
Exports the records found in a table (HFSQL or OLE DB), view or query to an XML file.
HExtractMemo (Function)
Extracts the content of a binary memo item from an HFSQL table, from a query or from an HFSQL view into a physical file (on disk).
HFileExist (Example)
Usage example of the HFileExist function
HFileExist (Function)
Determines:
  • whether a file exists, which means whether it was physically created (HCreation or HCreationIfNotFound).
  • whether a view or a query was defined.
HFilter (Function)
Defines and enables a filter on a table, view or query.
HFilterContains (Function)
Defines and enables a "Contains" filter on a table, view or query.
HFilterIdentical (Function)
Defines and enables a filter used to find the exact value of a string item.
HFilterIncludedBetween (Function)
Defines and enables an "Included between" filter on a file, view or query.
HFilterStartsWith (Function)
Defines and enables a "Start with" filter on a file, view or query.
HFirst (Function)
Sets the position on the first record of a table according to the specified browse item.
HFlush (Function)
Forces the operating system of the computer where the tables are found to write data onto the disk.
HForward (Example)
Usage example of the HForward function
HForward (Function)
Moves several records forward from the current position in the table, according to a specified item.
HFound (Function)
Checks whether the current record corresponds to the current filter or search.
HFree (Function)
Transforms the crossed records (HCross) into deleted records.
HFreePosition (Function)
Deletes a position saved by HSavePosition.
HFreeQuery (Function)
Releases query resources (following use of HExecuteQuery or HExecuteSQLQuery functions).
HFSQL constants
List of constants used by the HFSQL functions.
HFSQL functions
List of functions for HFSQL management
HFSQL functions (prefix syntax)
List of functions for HFSQL management
HFTListWord (Function)
Lists the words of the current record that will be taken into account by the full-text indexing.
HGetCurrentPosition (Function)
Returns the approximate position of current record in the table.
HHistoryModification (Function)
Returns the modifications performed on one or more items of a given record. The result can be displayed in a list box or in a table to allow the user to view the modifications made to the specified file.
HImportCSV (Function)
Imports a CSV file into an HFSQL Classic or Client/Server table. This table must have been defined in the data model editor, or declared with HDeclare, HDeclareExternal or HDescribeFile).
HImportHF55 (Function)
Imports a Hyper File 5.5 file into an HFSQL Classic file.
HImportJSON (Function)
Imports a JSON file into an HFSQL Classic table. This table must have been defined in the data model editor, or declared with HDeclare, HDeclareExternal or HDescribeFile).
HImportText (Function)
Imports a Text file into an HFSQL Classic or Client/Server table. This table must have been defined in the data model editor, or declared with HDeclare, HDeclareExternal or HDescribeFile).
HImportXLS (Function)
Imports an XLS file into an HFSQL Classic or Client/Server table. This table must have been defined in the data model editor, or declared with HDeclare, HDeclareExternal or HDescribeFile).
HImportXML (Function)
Imports an XML file into an HFSQL Classic or Client/Server table. This table must have been defined in the data model editor, or declared with HDeclare, HDeclareExternal or HDescribeFile).
HIndex (Example)
Usage example of the HIndex function
HIndex (Function)
Rebuilds the file index (".NDX" file).
HInfoAnalysis (Function)
Returns information about a database schema (WDD file).
HInfoFile (Function)
Returns the characteristics of an HFSQL Classic or Client/Server table.
HInfoMemo (Function)
Returns the characteristics of binary and text memos.
HInfoReplica (Function)
Returns information about the specified replica.
HInitHF55 (Function)
Used to access specific functions for managing xBase (or dBase) data if Native xBase Access provided with WINDEV or WEBDEV 14 is not available.
HInitSubscriber (Function)
Initializes the range of automatic identifiers for the description file of subscriber replica (".rpl" extension).
HJSONToRecord (Function)
Imports JSON data into the current record.
HLast (Function)
Sets the position on the last record of a table according to a browse item.
HLinkMemo (Example)
Usage example of the HLinkMemo function
HLinkMemo (Function)
Used to associate a file with a binary memo item or to cancel the existing link between a file and a binary item.
HListAnalysis (Example)
Usage example of the HListAnalysis function
HListAnalysis (Function)
Returns the list of WINDEV or WEBDEV database schemas (in HFSQL Classic format) available in a given directory.
HListConnection (Function)
Returns the list of connections currently described in the application:
  • connections described in the data model editor (for the main database schema and, if necessary, additional database schemas).
  • connections described by programming (with functions HDescribeConnection or HOpenConnection).
HListCustomFolder (Function)
Returns a list of defined Custom-Folders (also called groups):
  • in the current database schema,
  • in ongoing database schemas (projects with multiple database schemas).
  • in the specified database schema.
HListFile (Example)
Usage example of the HListFile function
HListFile (Function)
Returns the list of files:
  • current database schema.
  • database schemas in progress (projects with multiple database schemas).
  • a specific database schema 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.
HListFullTextIndex (Function)
Returns the list of full-text indexes of a file (a query or a view) recognized by the HFSQL engine.
HListItem (Function)
Returns the list of items:
HListKey (Function)
Returns the list of keys in a table (query or view) recognized by the HFSQL engine.
HListLink (Function)
Returns the list of table bindings (Merise type) present:
  • in the current database schema,
  • in ongoing database schemas (projects with multiple database schemas).
  • in a specific database schema.
HListProvider (Function)
Returns the list of OLE DB providers and/or Native Connectors installed on the current computer.
HListQueryParameter (Function)
Returns the list of parameters for a query created in the query editor.
HListREP (Function)
Returns the list of assignments for the tables handled by the current application, which means the list of physical files corresponding to the files described in the database schema.
HListSpatialKeys (Function)
Returns the spatial keys of a table (used in a query or view) recognized by the HFSQL engine.
HListStopWord (Function)
Returns the list of stop words used by a full-text index.
HListSynonym (Function)
Returns the list of synonyms used by a full-text index.
HLockFile (Function)
Locks a table and restricts the access to this table for all other sites or applications.
HLockRecNum (Function)
Locks a record and restricts the access to this record for all the other applications.
HMergeView (Function)
Creates an HFSQL view from two previously created views (HCreateView). This function uses the former view mechanism.
HMigrateLinkedCompositeKey (Function)
Migrates the values of the linked composite keys coming from a file in Hyper File 5.5 format to the HFSQL Classic format.
HMode (Function)
Changes the mode and the method for locking tables.
HModify (Example)
Usage example of the HModify function
HModify (Function)
Modifies the specified record or the record found in memory in the table (query or view).
HModifyStructure (Example)
Usage example of the HModifyStructure function
HModifyStructure (Function)
Used to update the structure of an HFSQL table by performing an automatic data modification (also called data synchronization).
HNbRec (Example)
Usage example of the HNbRec function
HNbRec (Function)
Returns the number of records in an HFSQL file, query or view: active records, deleted records, etc.
HNext (Function)
Sets the position on the next table record according to a browse item.
HNoModif (Function)
Forbids all the modifications on a table (for all the programs, including the one that requested the no-modification policy).
HOnError (Example)
Usage example of the HOnError function
HOnError (Function)
Customizes the management of HFSQL errors.
HOpen (Function)
Opens a table.
HOpenAnalysis (Function)
Opens a database schema in HFSQL Classic format.
HOpenComplementaryAnalysis (Function)
Opens a new database schema, but keeps the main database schema of the application.
HOpenConnection (Function)
Opens a connection to a specific database.
HOptimize (Function)
Used to handle the idle periods of a software (period without processes) to optimize the queries and the browses that will be run thereafter.
HOptimizeQuery (Function)
Optimizes the Select queries by using idle times when handling an application (period without processes).
HOut (Function)
Used to find out whether the record on which you want to be positioned is located outside the table, filter, view or query.
HPass (Function)
Defines the password used to create or open a table.
HPrepareQuery (Function)
Initializes a query and declares this query to the database server in order to optimize the next executions of this query.
HPrepareSQLQuery (Function)
Initializes a query written in SQL language and declares this query to the database server in order to optimize the next executions of this query.
HPrevious (Function)
Sets the position on the previous record of the table according to a browse item.
HQueryExecuted (Function)
Determines if a query has been executed.
HRead (Function)
Reads a record in a file according to a given record number.
HReadFirst (Function)
Positions on the first file record according to a browse item.
HReadLast (Example)
Usage example of the HReadLast function
HReadLast (Function)
Sets the position on the last record of a table according to a browse item.
HReadNext (Function)
Sets the position on the next table record according to a browse item.
HReadPrevious (Function)
Sets the position on the previous record of a file according to a browse item.
HReadSeek (Function)
Sets the position on the first record whose value for a specific item is greater than or equal to a sought value (generic search).
HReadSeekFirst (Example)
Usage example of the HReadSeekFirst function
HReadSeekFirst (Function)
Sets the position on the first record whose value for a specific item is strictly equal to a sought value (exact-match search).
HReadSeekLast (Function)
Sets the position on the last record whose value for a specific item is less than or equal to a sought value (exact-match search).
HRecNum (Function)
Returns:
  • the number of the current record in the HFSQL table.
  • the number of the current record in the HFSQL view.
HRecordDate (Function)
Returns the date and time of last write operation performed on a record in an HFSQL table (Classic or Client/Server).
HRecordToJSON (Function)
Retrieves the structure and value of the current record and exports them into a string in JASON format.
HRecordToString (Function)
Converts the content of the current record to string (in a table, HFSQL view, query, etc.).
HRecordToXML (Function)
Retrieves the structure and the value of the current record and exports them into a character string in XML format.
HRecreateSubscriberReplica (Function)
Recreates the subscriber replica description file (universal replication only) based on the information of the master replica (.rpm and .syn files).
HRefreshView (Function)
Asks to recalculate the content of a materialized view.
HRegenerateFile (Function)
Regenerates a table from its log.
HReindexingInProgress (Function)
Indicates that a reindex operation is currently performed on an HFSQL table and returns the percentage of reindexing already performed.
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.
HRestorePosition (Function)
Restores the previously saved context of a file (function HSavePosition): record in progress, filter, playback pointers.
HRetrieveItem (Function)
Returns the content of an item found in the current record (in the table, view, query, ...).
HRetrieveRecord (Function)
Returns the content of the current record (in a file, a view or a query, ...).
HSave (Function)
Modifies the current record if it exists, otherwise adds a new record.
HSavePosition (Function)
Stores the current file context (current record, filter, pointers).
HSecurity (Function)
Enables or disables the automatic security mechanism on one or more tables.
HSeek (Function)
Positions on the first record of the table whose value for a specific item is greater than or equal to a search value (generic search by default).
HSeekFirst (Function)
Positions on the first file record whose value for a specific item is greater than or equal to a sought value.
HSeekLast (Function)
Sets the position on the last file record whose value for a specific item is less than or equal to a sought value.
HSetDuplicates (Function)
Enables or disables the management of duplicates on a unique key.
HSetIntegrity (Function)
Enables or disables the management of an integrity constraint on a file link.
HSetMemo (Function)
Used to modify the management mode of memo items.
HSetPosition (Example)
Usage example of the HSetPosition function
HSetPosition (Function)
Sets the position on a record, based on the approximate position of one of its items.
HSetREP (Function)
Enables or disables the management of .REP files.
HSetReplication (Function)
Temporarily disables (or re-enables) the replication.
HSortView (Function)
Sorts an HFSQL view by creating an index on a view item. This function uses the former view mechanism.
HState (Example)
Usage example of the HState function
HState (Function)
Used to find out the state of a record.
HSubstDir (Example)
Usage example of the HSubstDir function
HSubstDir (Function)
Associates the data directory specified in the database schema with a directory found on disk.
HSynchronizeReplica (Example)
Usage example of the HSynchronizeReplica function
HSynchronizeReplica (Function)
Synchronizes master and subscriber replicas: operations performed on one replica are transferred to the other.
HToFile (Function)
Copies a data source (file, query, view, ...) to a physical HFSQL table with the same description. This table is neither encrypted nor password protected.
HToItem (Function)
Assigns the specified value to an item of the current record.
HUnlockFile (Function)
Unlocks the records of a table:
  • locked by HLockFile.
  • individually locked by a locking read function.
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).
HVersion (Function)
Used to find out:
  • whether the content of a file was modified.
  • whether the content of a file used by a query was modified.
HViewToFile (Example)
Usage example of the HViewToFile function
HViewToFile (Function)
Saves the modifications performed in an HFSQL view (by HModify, HDelete or HCross) in the corresponding table. This function uses the former view mechanism.
HWrite (Function)
Writes a record into a table without updating the indexes corresponding to all keys used in the table.
WithSpace (Function)
Adds or deletes the spaces found on the right of a text item when reading it.