PC SOFT

ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Home | Sign in | English EN

WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
Stored procedures
The following functions are used to manage HFSQL data files (prefixed syntax):
<Connection variable>.CloseConnectionCloses a connection to a database.
<Connection variable>.FileExistFinds out if a file exists, i.e. if it has been physically created (<Source>.Creation or <Source>.CreationIfNotFound).
<Connection variable>.InfoFileReturns the characteristics of an HFSQL Classic or Client/Server data file.
<Connection variable>.OpenConnectionOpens a connection to a specific database.
<Connection variable>.RefreshViewAsks to recalculate the content of a materialized view.
<Connection variable>.RegenerateFileRegenerates a data file from its log.
<Connection variable>.SetIntegrityEnables or disables the management of an integrity constraint on a file link.
<Connection variable>.TransactionStarts a transaction on the data files (HFSQL or accessed via Native Access) and creates the transaction file.
<Connection variable>.TransactionCancelIf a transaction is in progress, cancels all the operations performed on the data files in transaction since the start of transaction.
<Connection variable>.TransactionEndValidates 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.
<Connection variable>.TransactionStartStarts a transaction on the data files (HFSQL or accessed via Native Access) and creates the transaction file.
<HEX@>.DescribeTriggerAdds or modifies a trigger on a HFSQL data file.
<Source>.ActivateAutoFilterEnables an automatic filter on the linked files when browsing an XML file.
<Source>.ActivateFilterEnables the filter that was previously created for the specified data file (view or query).
<Source>.AddAdd:
  • 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).
<Source>.AliasCreates a logical alias of data file (or query) or cancels all existing aliases.
<Source>.BackwardMoves backward several records from the current position in the data file, according to a specified item.
<Source>.BuildKeyValueBuilds the value of a composite key to implement a filter (<Source>.Filter) or to perform a search (<Source>.ReadSeekFirst, <Source>.ReadSeekLast, etc.).
<Source>.CancelSeekCancels the current search criterion.
<Source>.ChangeConnectionDynamically changes the connection associated with a data file.
<Source>.ChangeDirModifies the access path to a data file (which means the directory where the file will be used).
<Source>.ChangeKeyChanges the browse item.
<Source>.ChangeLocationModifies the search mode of physical data files (.FIC, .NDX, ...).
<Source>.ChangeLogDirModifies the location of log files corresponding to an HFSQL data file.
<Source>.ChangeNameModifies the physical name of a data file.
<Source>.CheckIndexChecks whether the data found in the index file (.NDX file) properly refers the data found in the data file (.FIC file).
<Source>.CheckMemoChecks the structural integrity of memos in an HFSQL data file.
<Source>.CheckStructureDefines the mode for comparing data files.
<Source>.CheckUnalteredChecks whether one or all records in an unalterable data file have not been modified (with an hexadecimal editor for example).
<Source>.CloseCloses 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.
<Source>.CompareItemCompares 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, ...).
<Source>.CopyRecordCopy:
  • 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.
<Source>.CreateViewCreates an HFSQL view.
This function uses the former view mechanism.
<Source>.CreationCreates an empty data file (".FIC" extension) with the index file and the memo file if necessary.
<Source>.CreationIfNotFoundPerforms 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 <Source>.Creation.
  • If the file exists, opens the file.
<Source>.CrossCrosses a record in a data file.
<Source>.DeactivateAutoFilterDisables an automatic filter on the linked files when browsing an XML file.
<Source>.DeactivateFilterTemporarily disables the filter on a data file (view or query).
<Source>.DeclareDeclares a description of data file (found in an analysis) in the current project.
<Source>.DeclareExternalTemporarily imports into the current analysis the description of a data file from an existing HFSQL data file.
<Source>.DeleteDeletes a record from a data file (query or view).
<Source>.DeleteAllDeletes all records from a data file, a HFSQL view or a query.
<Source>.DeleteTriggerDeletes a trigger.
<Source>.DeleteViewDeletes a previously created view. This function uses the former view mechanism.
<Source>.DescribeFileDescribes a data file by programming.
<Source>.DuplicateRecordDuplicates the record read in a data file: the record found in memory is added into the data file (query or view).
<Source>.EndNoModifUnlocks a file that was locked by the same program with <Source>.NoModif.
<Source>.ErrorModificationReturns the value of a record item when a modification conflict occurs..
<Source>.ErrorStatusModificationReturns the status of a record during a modification conflict.
<Source>.ExécuteRequêteAsynchronousExecutes a SELECT query asynchronously.
<Source>.ExecuteSQLQueryAsynchronousExecutes an SQL query asynchronously.
<Source>.ExecuteViewRuns a view that was created beforehand (can be used to refresh the view data for example). This function uses the former view mechanism.
<Source>.ExportCSVExports the records found in a data file (HFSQL or OLE DB), a view or a query to a CSV file.
<Source>.ExportJSONExports the records found in a data file (HFSQL or OLE DB), view or query to a JSON file.
<Source>.ExportXLSExports records from a data file (HFSQL or OLE DB), view or query to an Excel file (XLSX).
<Source>.ExportXMLExports the records found in a data file (HFSQL or OLE DB), view or query to an XML file.
<Source>.ExtractMemoExtracts the content of a binary memo item from an HFSQL file, a query or an HFSQL view to a physical file (on disk).
<Source>.FileExistAllows you to find out:
<Source>.FilterDefines and enables a filter on a data file, view or query.
<Source>.FilterContainsDefines and enables a "Contains" filter on a data file, view or query.
<Source>.FilterIdenticalDefines and enables a filter used to find the exact value of a string item.
<Source>.FilterIncludedBetweenDefines and enables an "Included between" filter on a file, view or query.
<Source>.FilterStartsWithDefines and enables a "Start with" filter on a file, view or query.
<Source>.FirstSets the position on the first record of a data file according to the specified browse item.
<Source>.FlushForces the operating system of the computer where the data files are found to write data onto the disk.
<Source>.ForwardMoves several records forward from the current position in the data file, according to a specified item.
<Source>.FoundChecks whether the current record corresponds to the current filter or search.
<Source>.FreeTransforms the crossed records (<Source>.Cross) into deleted records.
<Source>.FreeQueryFree the resources of a query (after the call to 0 or 0).
<Source>.FTListWordLists the words of the current record that will be taken into account by the full-text indexing.
<Source>.GetCurrentPositionReturns the approximate position of current record in the data file.
<Source>.HistoryModificationReturns 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>.ImportHF55Imports a Hyper File 5.5 file into an HFSQL Classic file.
<Source>.ImportJSONImports a JSON file into a data file in HFSQL Classic format (data file described in the data model editor or declared by <Source>.Declare, <Source>.DeclareExternal or <Source>.DescribeFile).
<Source>.ImportTextImports 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 <Source>.Declare, <Source>.DeclareExternal or <Source>.DescribeFile).
<Source>.ImportXLSImports 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 <Source>.Declare, <Source>.DeclareExternal or HDescribeFile).
<Source>.ImportXMLImports an XML file into an HFSQL Classic or Client/Server data file (data file described in the data model editor or declared by <Source>.Declare, <Source>.DeclareExternal or <Source>.DescribeFile).
<Source>.IndexRebuilds the file index (".NDX" file).
<Source>.IndexingInProgressIndicates that a reindex operation is currently performed on a HFSQL data file and returns the percentage of reindexing already performed.
<Source>.InfoFileReturns the characteristics of an HFSQL Classic or Client/Server data file.
<Source>.InfoMemoReturns the characteristics of binary and text memos.
<Source>.InitSubscriberInitializes the range of automatic identifiers for the description file of subscriber replica (".RPL" extension).
Versions 26 and later
<Source>.JSONToRecord
New in version 26
<Source>.JSONToRecord
<Source>.JSONToRecord
Imports JSON data into the current record.
<Source>.LastSets the position on the last record of a data file according to a browse item.
<Source>.LinkMemoUsed to associate a file with a binary memo item or to cancel the existing link between a file and a binary item.
<Source>.ListFullTextIndexReturns the list of full-text indexes of a file (a query or a view) recognized by the HFSQL engine.
<Source>.ListItemReturns the list of items in a data file (query or view) recognized by the HFSQL engine. The data files defined by <Source>.Declare, <Source>.DeclareExternal and <Source>.DescribeFile are taken into account.
<Source>.ListKeyReturns the list of keys found in a file (query or view) recognized by the HFSQL engine.
<Source>.ListLinkReturns the list of links (Merise type) found in the current analysis or in a specific analysis.
<Source>.ListQueryParameterReturns the list of parameters for a query created in the query editor.
<Source>.ListStopWordReturns the list of stop words used by a full-text index.
<Source>.ListSynonymReturns the list of synonyms used by a full-text index.
<Source>.LockFileLocks a data file and restricts the access to this data file for all other sites or applications.
<Source>.LockRecNumLocks a record and restricts the access to this record for all the other applications.
<Source>.LogInfoAdds comments to the log when saving the operation.
<Source>.LogRecreateUsed to re-create an empty log.
<Source>.LogRestartRestarts the logging process on a file.
<Source>.LogStopStops the log process of a file.
<Source>.MergeViewCreates an HFSQL view from two previously created views (<Source>.CreateView). This function uses the former view mechanism.
<Source>.MigrateLinkedCompositeKeyMigrates the values of the linked composite keys coming from a file in Hyper File 5.5 format to the HFSQL Classic format.
<Source>.ModeChanges the mode and the method for locking data files.
<Source>.ModifyModifies the specified record or the record found in memory in the data file (query or view).
<Source>.ModifyStructureUsed to update the structure of an HFSQL data file by performing an automatic data modification (also called data synchronization).
<Source>.NbRecReturns the number of records in a file, query or HFSQL view: active records, crossed records, deleted records, etc.
<Source>.NextSets the position on the next data file record according to a browse item.
<Source>.NoModifForbids all the modifications on a data file (for all the programs, including the one that requested the no-modification policy).
<Source>.OnErrorCustomizes the management of HFSQL errors.
<Source>.OpenOpens a data file.
<Source>.OptimizeUsed to handle the idle periods of a software (period without processes) to optimize the queries and the browses that will be run thereafter.
<Source>.OutAllows 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>.PasswordDefines the password used to create or open a data file.
<Source>.PrepareQueryInitializes a query and declares this query to the database server in order to optimize the next executions of this query.
<Source>.PrepareSQLQueryInitializes 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>.PreviousPositions on the previous file record according to a browse item.
<Source>.ReadReads a record in a file according to a given record number.
<Source>.ReadFirstSets the position on the first record according to a browse item.
<Source>.ReadLastSets the position on the last record of a data file according to a browse item.
<Source>.ReadNextSets the position on the next data file record according to a browse item.
<Source>.ReadPreviousSets the position on the previous record of a file according to a browse item.
<Source>.ReadSeekSets the position on the first record whose value for a specific item is greater than or equal to a sought value (generic search).
<Source>.ReadSeekFirstSets the position on the first record whose value for a specific item is strictly equal to a sought value (exact-match search).
<Source>.ReadSeekLastSets 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>.RecNumReturns:
  • the number of the current record in the HFSQL data file.
  • the number of the current record in the HFSQL view.
<Source>.RecordDateReturns the date and time of the last write operation performed on a record in an HFSQL file (Classic or Client/Server).
<Source>.RecordToJSONRetrieves the structure and value of the current record and exports them into a string in JASON format.
Versions 26 and later
<Source>.RecordToString
New in version 26
<Source>.RecordToString
<Source>.RecordToString
Converts the content of the current record to string (in a data file, HFSQL view, query, etc.).
<Source>.RecordToXMLRetrieves the structure and the value of the current record and exports them into a character string in XML format.
<Source>.ResetInitialize:
  • one or all variables of file items with their default values.
  • one or all items of a Record variable with their default values.
<Source>.RetrieveItemReturns the content of an item found in the current record (in the data file, view, query, ...).
<Source>.RetrieveRecordReturns the content of the current record (in a file, a view or a query, ...).
<Source>.SaveModifies the current record if it exists, otherwise adds a new record.
<Source>.SavePositionStores the current file context: current record, filter, pointers.
<Source>.SecurityEnables or disables the automatic security mechanism on one or more data files.
<Source>.SeekPositions 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).
<Source>.SeekFirstPositions on the first file record whose value for a specific item is greater than or equal to a sought value.
<Source>.SeekLastSets the position on the last file record whose value for a specific item is less than or equal to a sought value.
<Source>.SetDuplicatesEnables or disables the management of duplicates on a unique key.
<Source>.SetLogEnables or disables log management on a file.
<Source>.SetMemoUsed to modify the management mode of memo items.
<Source>.SetPositionSets the position on a record, based on the approximate position of one of its items.
<Source>.SetRemoteAccessTemporarily disables the remote access in order to access HFSQL Classic data files found locally.
<Source>.SetTransactionEnables or disables the management of transactions for one or more files.
<Source>.SortViewSorts a HFSQL view by creating an index on a view item. This function uses the former view mechanism.
<Source>.StatCalculatePerforms various statistical calculations on the file keys.
<Source>.StatDateReturns the date of the last update for the index statistics.
<Source>.StateUsed to find out the state of a record.
<Source>.StatNbDuplicatesReturns the number of duplicates for a given key item.
<Source>.StatNbRecReturns the number of entries for a given key item.
<Source>.StatNbRecRangeReturns an estimate regarding the number of entries for a given key item in a given interval of values.
<Source>.StatTimeReturns the time of the last update for the index statistics.
<Source>.ToFileCopies a data source (file, query, view, ...) to a physical HFSQL file with the same description. This file is neither encrypted nor password protected.
<Source>.ToItemAssigns the specified value to an item of the current record.
<Source>.TransactionFreeTransforms all the records "in transaction" into "Normal" records if these records do not belong to a transaction currently in progress.
<Source>.UnlockFileUnlocks the records of a data file:
<Source>.UnlockRecNumUnlocks a record that was locked by:
<Source>.VersionUsed to find out:
  • whether the content of a file was modified.
  • whether the content of a file used by a query was modified.
<Source>.ViewToFileSaves the modifications performed in a HFSQL view (by <Source>.Modify, <Source>.Delete or <Source>.Cross) in the corresponding data file. This function uses the former view mechanism.
<Source>.WriteWrites a record into a data file without updating the indexes corresponding to all keys used in the file.
0Declares a query created in the query editor to the HFSQL engine and runs this query.
0Initializes a query written in SQL language and declares this query to the HFSQL engine.
Minimum version required
  • Version 25
This page is also available for…
Comments
Click [Add] to post a comment