<< Click here to display Table of Contents >>

HFSQL Functions

Contents

The following functions are used to manage HFSQL data files:


Convert	Converts a numeric value into a binary string in order to perform a search on a numeric key.
HAccelerateSpeed	Reorganizes the internal structure of the indexes to optimize the speed for accessing the data.
HActivateAutoFilter	Enables an automatic filter on the linked files when browsing an XML file.
HActivateFilter	Enables the filter that was previously created for the specified data file (view or query).
HActivateTrigger	Re-enables a trigger that was disabled by HDeactivateTrigger.
HAdd	Adds: •the record found in memory into the data file (query or view). •the record found in a Record variable into the data file (query or view).
HAlias	Creates a logical alias of a data file (or query) or cancels all existing aliases.
HBackward	Moves backward several records from the current position in the data file, according to a specified item.
HBuildKeyValue	Builds the value of a composite key to implement a filter (HFilter) or to perform a search (HReadSeekFirst, HReadSeekLast, etc.).
HBuildKeyValueANSI	Regardless of the platform used, the data saved in the HFSQL files is in ANSI format.
HCancelAlias	Cancels an alias that was declared beforehand by HAlias.
HCancelDeclaration	Allows to: •Delete a declaration made previously using HDeclare, HDeclareExternal, HDescriveFile. After this operation, the data file is no longer recognized by the HFSQL engine. •Free the resources of a query (after the call to HExecuteQuery or HExecuteSQLQuery).
HCancelSeek	Cancels the current search criterion.
HChangeConnection	Dynamically changes the connection associated with a data file.
HChangeDir	Modifies the access path to a data file (which means the directory where the file will be used).
HChangeKey	Changes the browse item.
HChangeLocation	Modifies the search mode of physical data files (.FIC, .NDX, ...).
HChangeLogDir	Modifies the location of log files corresponding to an HFSQL data file.
HChangeName	Modifies the physical name of a data file.
HChangeRplDir	Modifies the location for the description of subscriber replica (RPL file).
HCheckIndex	Checks whether the data found in the index file (.NDX file) properly refers the data found in the data file (.FIC file).
HCheckMemo	Checks the structural integrity of memos in an HFSQL data file.
HCheckStructure	Defines the mode for comparing data files.
HCheckUnaltered	Checks whether one or all records found in an unalterable data file have not been modified (with an hexadecimal editor for example).
HClose	Closes a data file or all the data files opened by the current user: all the corresponding physical data files are closed for the current user.
HCloseAnalysis	Closes the current analysis.
HCloseConnection	Closes a connection to a database.
HCompareItem	Compares two values by sorting them according to the specified HFSQL index item: all the sort options specified for the item are taken into account (sensitivity to the case, to the punctuation, sort direction, Unicode language, ...).
HComputer	Stores a unique computer number or identifier in order to use the log and transactions in network.
HConnect	Redefines one or more connection parameters via Native Access (Access, SQL Server, MySQL or Oracle) or via an OLE DB access on a specific table or set of tables.
HConnectRemoteAccess	Opens an analysis in HFSQL Classic format via a remote access (this function is equivalent to the second syntax of HOpenAnalysis).
HConvertX	Converts a numeric value into a binary string in order to perform a search on a numeric key.
HCopyRecord	Copies: •the content of current record (loaded in memory) into the current record of a data file. •the content of Record variable into the current record of a data file.
HCreateMasterReplica	Creates the description file of a Master Replica (logged replication or universal replication).
HCreateMoveableReplica	Creates a movable replication.
HCreateSubscriberReplica	Creates the description file of a subscriber replica.
HCreateView	Creates an HFSQL view. This function uses the former view mechanism.
HCreation	Creates an empty data file (".FIC" extension) with the index file and the memo file if necessary.
HCreationIfNotFound	Performs the following operations: •If the file does not exist, creates an empty data file (".FIC" file) with the index file and the memo file if necessary. The function is equivalent to HCreation. •If the file exists, opens the file.
HCross	Crosses a record in a data file.
HDBCreation	Ends the description of the structure of an xBase data file by programming.
HDBDescribeField	Describes by programming each item found in the structure of an xBase file described by HDBDescribeFile.
HDBDescribeFile	Describes a file in dBase3 format (most common format) by programming.
HDBDescribeIndex	Describes by programming the different index files that will be created.
HDBIndex	Opens an xBase index file.
HDBOpen	Opens the xBase data file and the "memo" file if it exists.
HDBOpenNoLock	In single-user mode, opens an xBase data file without locking it.
HDBSortType	Returns or modifies the sequence of text items in the xBase files.
HDeactivateAutoFilter	Disables an automatic filter on the linked files when browsing an XML file.
HDeactivateFilter	Temporarily disables the filter on a data file (view or query).
HDeactivateTrigger	Disables a trigger.
HDeclare	Declares a description of data file (found in an analysis) in the current project.
HDeclareExternal	Temporarily imports into the current analysis the description of a data file from an existing HFSQL data file.
HDelete	Deletes a record from a data file (query or view).
HDeleteAll	Deletes all records from a data file, a HFSQL view or a query.
HDeleteTrigger	Deletes a trigger.
HDeleteView	Deletes a previously created view. This function uses the former view mechanism.
HDescribeConnection	Describes a new connection to an external database.
HDescribeFile	Describes a data file by programming.
HDescribeFullTextIndex	Describes a full-text index of data file created by programming.
HDescribeItem	Describes a file item by programming.
HDescribeLink	Describes a link between two data files by programming.
HDescribeTrigger	Adds or modifies a trigger on an HFSQL data file.
HDuplicateRecord	Duplicates the record read in a data file: the record found in memory is added into the data file (query or view).
HEndNoModif	Unlocks a file that was locked by the same program with HNoModif.
HError	Returns the number of the last error triggered by the HFSQL engine.
HErrorDuplicates	Used to check whether a duplicate error occurred.
HErrorInfo	Returns a detailed information about the last error triggered by the HFSQL engine.
HErrorIntegrity	Used to check whether an integrity error occurred.
HErrorLock	Used to check whether a lock error occurred.
HErrorModification	Used to: •return the value of a record item if a modification conflict occurs. •check if a modification conflict occurred.
HErrorPassword	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.
HErrorStatusModification	Returns the status of a record during a modification conflict.
HExecuteQuery	Declares a query created in the query editor to the HFSQL engine and runs this query.
HExecuteQueryAsynchronous	Executes a SELECT query asynchronously.
HExecuteSQLQuery	Initializes a query written in SQL language and declares this query to the HFSQL engine.
HExecuteSQLQueryAsynchronous	Executes an SQL query asynchronously.
HExecuteView	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	Exports the records found in a data file (HFSQL or OLE DB), a view or a query to a CSV file.
HExportJSON	Exports the records found in a data file (HFSQL or OLE DB), view or query to a JSON file.
HExportXLS	Exports records from a data file (HFSQL or OLE DB), view or query to an Excel file (XLSX).
HExportXML	Exports the records found in a data file (HFSQL or OLE DB), view or query to an XML file.
HExtractMemo	Extracts the content of a binary memo item from an HFSQL file, a query or an HFSQL view to a physical file (on disk).
HFileExist	Used to find out: •whether a file exists, which means whether it was physically created (HCreation or HCreationIfNotFound). •whether a view or a query was defined.
HFilter	Defines and enables a filter on a data file, view or query.
HFilterContains	Defines and enables a "Contains" filter on a data file, view or query.
HFilterIdentical	Defines and enables a filter used to find the exact value of a string item.
HFilterIncludedBetween	Defines and enables an "Included between" filter on a file, view or query.
HFilterStartsWith	Defines and enables a "Start with" filter on a file, view or query.
HFirst	Sets the position on the first record of a data file according to the specified browse item.
HFlush	Forces the operating system of the computer where the data files are found to write data onto the disk.
HForward	Moves several records forward from the current position in the data file, according to a specified item.
HFound	Checks whether the current record corresponds to the current filter or search.
HFree	Transforms the crossed records (HCross) into deleted records.
HFreePosition	Deletes a position saved by HSavePosition.
HFreeQuery	Free the resources of a query (after the call to HExecuteQuery or HExecuteSQLQuery).
HFTListWord	Lists the words of the current record that will be taken into account by the full-text indexing.
HGetCurrentPosition	Returns the approximate position of current record in the data file.
HHistoryModification	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.
HImportHF55	Imports a Hyper File 5.5 file into an HFSQL Classic file.
HImportJSON	Imports a JSON file into a data file in HFSQL Classic format (data file described in the data model editor or declared by HDeclare, HDeclareExternal or HDescribeFile).
HImportText	Imports a Text file into a data file in HFSQL Classic or Client/Server format (data file described in the data model editor, or declared by HDeclare, HDeclareExternal or HDescribeFile).
HImportXLS	Imports an XLS file into a data file in HFSQL Classic or Client/Server format (data file described in the data model editor, or declared by HDeclare, HDeclareExternal or HDescribeFile).
HImportXML	Imports an XML file into an HFSQL Classic or Client/Server data file (data file described in the data model editor or declared by HDeclare, HDeclareExternal or HDescribeFile).
HIndex	Rebuilds the file index (".NDX" file).
HIndexingInProgress	Indicates that a reindex operation is currently performed on a HFSQL data file and returns the percentage of reindexing already performed.
HInfoAnalysis	Returns information about an analysis (WDD file).
HInfoFile	Returns the characteristics of an HFSQL Classic or Client/Server data file.
HInfoMemo	Returns the characteristics of binary and text memos.
HInfoReplica	Returns information about the specified replica.
HInitHF55	Used to access specific functions for managing xBase (or dBase) data if Native xBase Access supplied with WINDEV or WEBDEV 14 is not available.
HInitSubscriber	Initializes the range of automatic identifiers for the description file of subscriber replica (".RPL" extension).
HJSONToRecord	Imports JSON data into the current record.
HLast	Sets the position on the last record of a data file according to a browse item.
HLinkMemo	Used to associate a file with a binary memo item or to cancel the existing link between a file and a binary item.
HListAnalysis	Returns the list of WINDEV or WEBDEV analyses (in HFSQL Classic format) available in a given directory.
HListConnection	Returns the list of connections currently described in the application.
HListCustomFolder	Returns the list of Custom-Folders (also called groups) defined in the analysis.
HListFile	Returns the list of files: •found in the current analysis or in a specific analysis recognized by the HFSQL engine. The files defined by HDeclare, HDeclareExternal and HDescribeFile are taken into account. •available on a connection via a native access or via an OLE DB driver. •for a group of files defined in the data model editor.
HListFullTextIndex	Returns the list of full-text indexes of a file (a query or a view) recognized by the HFSQL engine.
HListItem	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.
HListKey	Returns the list of keys found in a file (query or view) recognized by the HFSQL engine.
HListLink	Returns the list of links (Merise type) found in the current analysis or in a specific analysis.
HListProvider	Returns the list of OLE DB providers and/or Native Connectors installed on the current computer.
HListQueryParameter	Returns the list of parameters for a query created in the query editor.
HListREP	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.
HListStopWord	Returns the list of stop words used by a full-text index.
HListSynonym	Returns the list of synonyms used by a full-text index.
HListTrigger	Returns the list of triggers applied to one or more HFSQL data files.
HLockFile	Locks a data file and restricts the access to this data file for all other sites or applications.
HLockRecNum	Locks a record and restricts the access to this record for all the other applications.
HLogInfo	Adds comments to the log when saving the operation.
HLogRecreate	Used to re-create an empty log.
HLogRestart	Restarts the logging process on a file.
HLogStop	Stops the log process of a file.
HMergeView	Creates an HFSQL view from two previously created views (HCreateView). This function uses the former view mechanism.
HMigrateLinkedCompositeKey	Migrates the values of the linked composite keys coming from a file in Hyper File 5.5 format to the HFSQL Classic format.
HMode	Changes the mode and the method for locking data files.
HModify	Modifies the specified record or the record found in memory in the data file (query or view).
HModifyStructure	Used to update the structure of an HFSQL data file by performing an automatic data modification (also called data synchronization).
HNbRec	Returns the number of records in a file, query or HFSQL view: active records, crossed records, deleted records, etc.
HNext	Sets the position on the next data file record according to a browse item.
HNoModif	Forbids all the modifications on a data file (for all the programs, including the one that requested the no-modification policy).
HOnError	Customizes the management of HFSQL errors.
HOpen	Opens a data file.
HOpenAnalysis	Opens an analysis in HFSQL Classic format.
HOpenConnection	Opens a connection to a specific database.
HOptimize	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	Optimizes the Select queries by using idle times when handling an application (period without processes).
HOut	Used to find out whether the record on which you want to be positioned is located outside the data file, filter, view or query.
HPass	Defines the password used to create or open a data file.
HPrepareQuery	Initializes a query and declares this query to the database server in order to optimize the next executions of this query.
HPrepareSQLQuery	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	Positions on the previous file record according to a browse item.
HRead	Reads a record in a file according to a given record number.
HReadFirst	Sets the position on the first record according to a browse item.
HReadLast	Sets the position on the last record of a data file according to a browse item.
HReadNext	Sets the position on the next data file record according to a browse item.
HReadPrevious	Sets the position on the previous record of a file according to a browse item.
HReadSeek	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	Sets the position on the first record whose value for a specific item is strictly equal to a sought value (exact-match search).
HReadSeekLast	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	Returns: •the number of the current record in the HFSQL data file. •the number of the current record in the HFSQL view.
HRecordDate	Returns the date and time of the last write operation performed on a record in an HFSQL file (Classic or Client/Server).
HRecordToJSON	Retrieves the structure and value of the current record and exports them into a string in JASON format.
HRecordToString
HRecordToXML	Retrieves the structure and the value of the current record and exports them into a character string in XML format.
HRecreateSubscriberReplica	Re-creates the description file of a subscriber replica (universal replication only) according to the information of the master replica (.RPM and.SYN files).
HRefreshView	Asks to recalculate the content of a materialized view.
HRegenerateFile	Regenerates a data file from its log.
HReset	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	Restores the file context that was saved beforehand (HSavePosition): current record, filter, pointers.
HRetrieveItem	Returns the content of an item found in the current record (in the data file, view, query, ...).
HRetrieveRecord	Returns the content of the current record (in a file, a view or a query, ...).
HRplDeclareLink	Declares a (1, 1) (0, n) link between two tables.
HRplFilterProcedure	Defines the WLanguage procedure that will be called whenever a replication operation is performed on a specific file.
HRplManageFile	Defines the options used for the universal replication of a file: •the replication direction. •the management mode of conflicts.
HRplManageItem	Specifies the replication options for an item: the item can be replicated or not.
HRplPass	Sets the passwords used to protect the universal replication files.
HSave	Modifies the current record if it exists, otherwise adds a new record.
HSavePosition	Stores the current file context: current record, filter, pointers.
HSecurity	Enables or disables the automatic security mechanism on one or more data files.
HSeek	Positions on the first record of the data file whose value for a specific item is greater than or equal to a sought value (generic search by default).
HSeekFirst	Positions on the first file record whose value for a specific item is greater than or equal to a sought value.
HSeekLast	Sets the position on the last file record whose value for a specific item is less than or equal to a sought value.
HSetDuplicates	Enables or disables the management of duplicates on a unique key.
HSetIntegrity	Enables or disables the management of an integrity constraint on a file link.
HSetLog	Enables or disables log management on a file.
HSetMemo	Used to modify the management mode of memo items.
HSetPosition	Sets the position on a record, based on the approximate position of one of its items.
HSetRemoteAccess	Temporarily disables the remote access in order to access HFSQL Classic data files found locally.
HSetREP	Enables or disables the management of .REP file.
HSetReplication	Temporarily disables (or re-enables) the replication.
HSetTransaction	Enables or disables the management of transactions for one or more files.
HSetTrigger	Enables or disables the management of triggers.
HSortView	Sorts a HFSQL view by creating an index on a view item. This function uses the former view mechanism.
HStatCalculate	Performs various statistical calculations on the file keys.
HStatDate	Returns the date of the last update for the index statistics.
HState	Used to find out the state of a record.
HStatNbDuplicates	Returns the number of duplicates for a given key item.
HStatNbRec	Returns the number of entries for a given key item.
HStatNbRecRange	Returns an estimate regarding the number of entries for a given key item in a given interval of values.
HStatTime	Returns the time of the last update for the index statistics.
HSubstDir	Associates the data directory specified in the analysis with a directory found on disk.
HSynchronizeReplica	Synchronizes the master replica and the subscriber replica: the operations performed on one of the replicas are transferred into the other replica.
HToFile	Copies a data source (file, query, view, ...) to a physical HFSQL file with the same description. This file is neither encrypted nor password protected.
HToItem	Assigns the specified value to an item of the current record.
HTransaction	Starts a transaction on the data files (HFSQL or accessed via a Native Connector) and creates the transaction file.
HTransactionCancel	If a transaction is in progress, cancels all the operations performed on the data files in transaction since the start of transaction.
HTransactionEnd	Validates the current transaction: •the modifications performed on the data file 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.
HTransactionFree	Transforms all the records "in transaction" into "Normal" records if these records do not belong to a transaction currently in progress.
HTransactionInProgress	Used to find out whether a transaction is in progress.
HTransactionInterrupted	Used to find out whether a transaction was interrupted (the transaction was neither validated nor canceled).
HTransactionStart	Starts a transaction on the data files (HFSQL or accessed via a Native Connector) and creates the transaction file.
HTriggerRecordBefore	Retrieves the value of the current record before the trigger(s) are executed.
HUnlockFile	Unlocks the records of a data file: •locked by HLockFile. •individually locked by a locking read function.
HUnlockRecNum	Unlocks a record that was locked by: •HLockRecNum, •a read function used with a locking parameter (HRead associated with the hLockWrite or hLockReadWrite constant for example).
HVersion	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	Saves the modifications performed in a HFSQL view (by HModify, HDelete or HCross) in the corresponding data file. This function uses the former view mechanism.
HWrite	Writes a record into a data file without updating the indexes corresponding to all keys used in the file.
WithSpace	Adds or deletes the spaces found on the right of a text item when reading it.