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/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Others
Stored procedures
Display constants used by prefix syntaxes only
The following constants are used to manage HFSQL data files:
ConstantDescriptionFunctions/Properties
eltSetOfProceduresThe listed element is a set of proceduresHListStoredElement
eltProcedureThe listed element is a stored procedureHListStoredElement
eltQueryThe listed element is a query.HListStoredElement
Versions 15 and later
h3G
New in version 15
h3G
h3G
Type of network to simulate: 3GHSimulateNetwork
hAcceptOpenedFileAllows you to read the source file that will be added to the memo if this source file is opened in write mode somewhere else.HLinkMemo
hAccessHF7Pseudo-connection to HFSQL Classic database.HConnect, HDeclareExternal,
HDescribeConnection, HListFile,
HOpenConnection,
Provider property, CtOLEDBProvider property, CtDescribedOLEDBProvider property
hAccessHFClientServerProvider that will be used for the connection: Native Connector to an HFSQL Client/Server databaseHConnect, HDeclareExternal,
HDescribeConnection, HListFile,
HOpenConnection,
Provider property, CtOLEDBProvider property, CtDescribedOLEDBProvider property
hAccessJDBCMySQLAccess to a MySQL database via a JDBC driverHDescribeConnection,
HOpenConnection
hAccessJDBCSQLServerAccess to an SQL Server database via a JDBC driverHDescribeConnection,
HOpenConnection
hNativeAccessAS400Provider that will be used for the connection: Native AS/400 Connector (optional module of WINDEV)HConnect, HDeclareExternal,
HDescribeConnection, HListFile,
HOpenConnection,
Provider property, CtOLEDBProvider property, CtDescribedOLEDBProvider property
hNativeAccessDB2OLE DB provider that will be used for the connection: Native DB2 Connector (optional module of WINDEV)HConnect, HDeclareExternal,
HDescribeConnection, HListFile,
HOpenConnection,
Provider property, CtOLEDBProvider property, CtDescribedOLEDBProvider property
hNativeAccessInformixOLE DB provider that will be used for the connection: Native Informix Connector (optional module of WINDEV)HConnect, HDeclareExternal,
HDescribeConnection, HListFile,
HOpenConnection,
Provider property, CtOLEDBProvider property, CtDescribedOLEDBProvider property
Versions 20 and later
hNativeAccessMariaDB
New in version 20
hNativeAccessMariaDB
hNativeAccessMariaDB
OLE DB provider that will be used for the connection: Native MariaDB Connector (optional module of WINDEV/WEBDEV)HConnect, HDeclareExternal,
HDescribeConnection, HListFile,
HOpenConnection,
Provider property, CtOLEDBProvider property, CtDescribedOLEDBProvider property
hNativeAccessMySQLOLE DB provider that will be used for the connection: Native MySQL ConnectorHConnect, HDeclareExternal,
HDescribeConnection, HListFile,
HOpenConnection,
Provider property, CtOLEDBProvider property, CtDescribedOLEDBProvider property
hNativeAccessOracleOLE DB provider that will be used for the connection: Native Oracle Connector (optional module of WINDEV)HConnect, HDeclareExternal,
HDescribeConnection, HListFile,
HOpenConnection,
Provider property, CtOLEDBProvider property, CtDescribedOLEDBProvider property
hNativeAccessOracleLiteProvider that will be used for the connection: Native Oracle Connector (optional module of WINDEV Mobile)HConnect, HDeclareExternal,
HDescribeConnection, HListFile,
HOpenConnection,
Provider property, CtOLEDBProvider property, CtDescribedOLEDBProvider property
hNativeAccessPostgreSQLOLE DB provider that will be used for the connection: Native PostgreSQL ConnectorHConnect, HDeclareExternal,
HDescribeConnection, HListFile,
HOpenConnection,
Provider property, CtOLEDBProvider property, CtDescribedOLEDBProvider property
hNativeAccessProgressOLE DB provider that will be used for the connection: Native Progress Connector (optional module of WINDEV)HConnect, HDeclareExternal,
HDescribeConnection, HListFile,
HOpenConnection,
Provider property, CtOLEDBProvider property, CtDescribedOLEDBProvider property
Versions 16 and later
hNativeAccessSQLAzure
New in version 16
hNativeAccessSQLAzure
hNativeAccessSQLAzure
OLE DB provider that will be used for the connection: Native SQL Azure ConnectorHConnect, HDeclareExternal,
HDescribeConnection, HListFile,
HOpenConnection,
Provider property, CtOLEDBProvider property, CtDescribedOLEDBProvider property
Versions 15 and later
hNativeAccessSQLite
New in version 15
hNativeAccessSQLite
hNativeAccessSQLite
OLE DB provider that will be used for the connection: Native Connector to an SQLite databaseHConnect, HDeclareExternal,
HDescribeConnection, HListFile,
HOpenConnection,
Provider property, CtOLEDBProvider property, CtDescribedOLEDBProvider property
hNativeAccessSQLServerOLE DB provider that will be used for the connection: Native SQL Server Connector (optional module of WINDEV)HConnect, HDeclareExternal,
HDescribeConnection, HListFile,
HOpenConnection,
Provider property, CtOLEDBProvider property, CtDescribedOLEDBProvider property
hNativeAccessSQLServerMobileProvider that will be used for the connection: Native SQL Server Mobile Connector (optional module of WINDEV Mobile)HConnect, HDeclareExternal,
HDescribeConnection, HListFile,
HOpenConnection,
Provider property, CtOLEDBProvider property, CtDescribedOLEDBProvider property
hNativeAccessSybaseOLE DB provider that will be used for the connection: Native Sybase Connector (optional module of WINDEV)HConnect, HDeclareExternal,
HDescribeConnection, HListFile,
HOpenConnection,
Provider property, CtOLEDBProvider property, CtDescribedOLEDBProvider property
hNativeAccessXBaseOLE DB provider that will be used for the connection: Native xBase ConnectorHConnect, HDeclareExternal,
HDescribeConnection, HListFile,
HOpenConnection,
Provider property, CtOLEDBProvider property, CtDescribedOLEDBProvider property
hNativeAccessXMLProvider that will be used for the connection: Native XML Connector (included with WINDEV/WEBDEV)HConnect, HDeclareExternal,
HDescribeConnection, HListFile,
HOpenConnection,
Provider property, CtOLEDBProvider property, CtDescribedOLEDBProvider property
Versions 23 and later
hActiveDirectory
New in version 23
hActiveDirectory
hActiveDirectory
Enable the authentication via Active Directory. HSetServer
Versions 15 and later
hADSL
New in version 15
hADSL
hADSL
Type of network to simulate: ADSLHSimulateNetwork
hAffectBrowseAddition affecting the current browseHAdd, HModify
hApplicationProperty of a database found on an HFSQL server: Name of the application from which the database was created.HInfoDatabaseProperty, HInfoFileProperty
hStoppedServer stoppedHServerStatus
Versions 15 and later
hNone
New in version 15
hNone
hNone
Used to disable the simulation of a specific network.HSimulateNetwork
hAllowedThe relevant rights are granted to the user or group.HModifyDatabaseRights,
HModifyFileRights,
HModifyServerRights
hWithFilterThe query result corresponds to a selection of filter records if the HFSQL engine allows it. Otherwise, the query result corresponds to an HFSQL view.HExecuteQuery, HExecuteSQLQuery
hWithTransactionThe query is run in a transaction. HExecuteQuery, HExecuteSQLQuery
hLockWriteType of lock: Lock in write modeHAdd, HForward, HLockFile, HLockRecNum, HLast, HWrite, HRead, HReadLast, HReadPrevious, HReadFirst, HReadSeekLast, HReadSeekFirst, HReadNext, HModify, HPrevious, HFirst, HCross, HSeek, HSeekLast, HSeekFirst, HBackward, HNext
hLockReadWriteType of lock: Lock in read/writeHAdd, HForward, HLockFile, HLockRecNum, HLast, HWrite, HRead, HReadLast, HReadPrevious, HReadFirst, HReadSeekLast, HReadSeekFirst, HReadNext, HModify, HPrevious, HFirst, HCross, HSeek, HSeekLast, HSeekFirst, HBackward, HNext
hLockNoType of lock: No lockHAdd, HForward, HLockFile, HLockRecNum, HLast, HWrite, HRead, HReadLast, HReadPrevious, HReadFirst, HReadSeekLast, HReadSeekFirst, HReadNext, HModify, HPrevious, HFirst, HCross, HSeek, HSeekLast, HSeekFirst, HBackward, HNext
Versions 21 and later
hCacheNbUnusedFiles
New in version 21
hCacheNbUnusedFiles
hCacheNbUnusedFiles
Maximum number of unused HFSQL tables that are stored in cache (which means opened) on the server. HSetServer
Versions 18 and later
hAutoStatisticalCalc
New in version 18
hAutoStatisticalCalc
hAutoStatisticalCalc
Enable the automatic calculation of statistics for the data files (optimization of indexes).HSetServer
hCardinalityIntegrity constraints: Check the link cardinalities.HSetIntegrity
hInfiniteCardinalityMaximum cardinality ("N")MaxLinkedCardinality property, MaxSourceCardinality property
hChangeCharsetThe character set defined by ChangeCharset will be taken into account in the new data file. Sorts, searches, ... on string keys (strings, characters, date and time) will be performed according to this character set.HCreation,
HCreationIfNotFound,
HIndex
hDatabasePathPath of directory containing all databasesHSetServer
hJNLPathPath of the directory containing all the logs of the different HFSQL Client/Server applicationsHSetServer
hJNLBackupPathPath of the directory containing the backups of the logsHSetServer
hLogPathPath of the directory containing the log filesHSetServer
hActivityStatisticsPathPath of the directory containing the activity statisticsHSetServer
hDuplicateKeyCharacteristics of an item: Key with duplicatesKeyType property
hUniqueKeyCharacteristics of an item: Unique keyKeyType property
Versions 20 and later
hSQLCode
New in version 20
hSQLCode
hSQLCode
Requested information: SQL code of the materialized view
Versions 20 and later
HInfoView
New in version 20
HInfoView
HInfoView
hCompatibleThe structures of the data files (defined in the analysis and found in the physical file) must be compatible.HCheckStructure
hPackNoCompression mode: No compressionMmoPackMethod property
hPackZLWCompression mode: Compression based on the Ziw-Lempel algorithm, Welch implementation.MmoPackMethod property
hKeepTRSStores the transaction files during the deletionHDeleteDatabase,
HDeleteFile
hCopyAutoIDCopies the automatic identifier while keeping its valueHCopyRecord, HImportHF55,
HImportText,
Versions 20 and later
HImportXLS
New in version 20
HImportXLS
HImportXLS
hCopyIndexCopies the index of the data fileHCopyFile
hCopyIfNotFoundCopies the data file only if it does not exist at the specified location on the destination computer.HCopyFile
hCorrespondenceGives the correspondence between the numbers of the log functions and the names of the WLanguage functionsHInfoLog
hCreatorProperty of a database found on an HFSQL server: Name of database owner.HInfoDatabaseProperty, HInfoFileProperty
hCreateIndexThe index of the data file is not copied. It is automatically re-created on the destination by re-indexing.HCopyFile
hIncreasingSort performed in ascending orderSortType property
Versions 24 and later
hCryptAES128
New in version 24
hCryptAES128
hCryptAES128
File encryption performed only if a password is defined for the file. In this case, the file is encrypted using a 128-bit AES algorithm with Output feedback (OFB).FicCryptMethod property, MmoCryptMethod property, NdxCryptMethod property
Versions 27 and later
hCryptAES128
New in version 27
hCryptAES128
hCryptAES128
File encryption performed only if a password is defined for the file. In this case, the file is encrypted using a 192-bit AES algorithm with Output feedback (OFB).FicCryptMethod property, MmoCryptMethod property, NdxCryptMethod property
Versions 27 and later
hEncryptionAES256
New in version 27
hEncryptionAES256
hEncryptionAES256
File encryption performed only if a password is defined for the file. In this case, the file is encrypted using a 256-bit AES algorithm with Output feedback (OFB).FicCryptMethod property, MmoCryptMethod property, NdxCryptMethod property
Versions 19 and later
hEncryptionAuto
New in version 19
hEncryptionAuto
hEncryptionAuto
File encryption performed only if a password is defined for the file. In this case, the data file is encrypted according to an optimized encryption algorithm (RC5 16 rounds on 128 bits).FicCryptMethod property, MmoCryptMethod property, NdxCryptMethod property
hEncryptionNONo file encryption.FicCryptMethod property, MmoCryptMethod property, NdxCryptMethod property
hEncryptionRC5_12The file is encrypted according to an optimized encryption algorithm (RC5 12 rounds on 128 bits).FicCryptMethod property, MmoCryptMethod property, NdxCryptMethod property
hEncryptionRC5_16The file is encrypted according to an optimized encryption algorithm (RC5 16 rounds on 128 bits).FicCryptMethod property, MmoCryptMethod property, NdxCryptMethod property
hEncryptionStandardThe memo file is encrypted according to an optimized encryption algorithm on 128 bits.FicCryptMethod property, MmoCryptMethod property, NdxCryptMethod property
hClientCursorCursor managed by MDAC. Offers more features than a server cursor. A client cursor must necessarily be a static cursorHDescribeConnection,
HOpenConnection
hDynamicCursorCursor offering a lot of features but consuming a lot of memory. This cursor allows all types of moves. It allows you to access all the modifications, additions and deletions performed by the other users.HDescribeConnection,
HOpenConnection
hForwardOnlyCursorFast cursor consuming little memory. The move is performed from the first record to the last one. The data modified by the other users is not visible.HDescribeConnection,
HOpenConnection
hReadOnlyCursorThe set of records cannot be modified.HDescribeConnection,
HOpenConnection
hOpenKeysetCursorCursor that handles a fixed set of records. Only the keys corresponding to the record are stored and not the records (consumes less memory). The deleted records can no longer be accessed. Modifications performed by other users are visible (but records added are not).HDescribeConnection,
HOpenConnection
hOptimisticCursorThe record is locked when it is updatedHDescribeConnection,
HOpenConnection
hPessimisticCursorThe record is locked as soon as it goes into edit mode to be modified.HDescribeConnection,
HOpenConnection
hServerCursorCursor managed by the database. This cursor can easily apply the changes performed by the other users to the data.HDescribeConnection,
HOpenConnection
hStaticCursorMakes a copy of all query records in memory (high memory usage). All types of moves are allowed.HDescribeConnection,
HOpenConnection
hDaemonUserUsername that will be used by the server (Linux only)HSetServer
hDateProperty of a database found on an HFSQL server: Creation date of the database.HInfoDatabaseProperty, HInfoFileProperty
Versions 20 and later
hDateLastRefresh
New in version 20
hDateLastRefresh
hDateLastRefresh
Requested information: Date of the last successful refresh for the materialized view.
Versions 20 and later
HInfoView
New in version 20
HInfoView
HInfoView
hDBASCIISort according to ASCII orderHDBSortType
hDisconnectionConfigures the disconnection messageHOnServerCall
hDBLexicographicSort according to the lexicographic orderHDBSortType
hDecreasingSort performed in descending orderSortType property
hDefaultThe rights returned do not take the inherited rights into account (rights granted to the groups to which the user belongs).
If no rights were defined, the value will be set to hInherit.
<Result> contains the values of the requested rights (in the same order).
HInfoDatabaseRights,
HInfoFileRights,
HInfoServerRights
hStartedServer startedHServerStatus
hDetailsThe rights returned do not take the inherited rights into account (rights granted to the groups to which the user belongs).
If no rights were defined, the value will be set to hInherit.
<Result> contains the rights and there value.
HInfoDatabaseRights,
HInfoFileRights,
HInfoServerRights
hDestroyLinkDeletes all links related to the deleted data file.HDeleteFile
hDiskSearch mode for the data files or the analyses: The files are sought on the disk only. This is the most common caseHChangeLocation,
HDeclare
hDistinctManagement of duplicates during the browse: Only one record is read if duplicates are found when looping through a key itemHForward, HReadPrevious,
HReadNext, HPrevious,
HBackward, HNext
hDataConfigure the file management: All the operations stored in the log file are applied to the existing fileHRegenerateFile
hRightsInsertRights to add new records into a data file.HInfoDatabaseRights,
HInfoFileRights,
HModifyDatabaseRights,
HModifyFileRights
hRightsStopServerRights to stop a server (HStopServer)HInfoServerRights,
HModifyServerRights
hRightsLockRights to lock the data files or the records of a data file.HInfoDatabaseRights,
HInfoFileRights,
HModifyDatabaseRights,
HModifyFileRights
hRightsChangeRightsRights to change rights.HInfoDatabaseRights,
HInfoFileRights,
HInfoServerRights,
HModifyDatabaseRights,
HModifyFileRights,
HModifyServerRights
hRightsChangeLinkRights to modify the integrity rules on a data file.HInfoDatabaseRights,
HInfoFileRights,
HModifyDatabaseRights,
HModifyFileRights
hRightsChangePasswordRights to change the password of a user on the server (the user can change his own password and the administrator can change the password of each user).HInfoServerRights,
HModifyServerRights
hRightsChangeOwnerRights to modify the owner of an elementHInfoDatabaseRights,
HInfoFileRights,
HModifyDatabaseRights,
HModifyFileRights
hRightsConnectionRights to connect to a server (encrypted or unencrypted connection)HInfoDatabaseRights,
HModifyDatabaseRights
hRightsEncryptedConnectionRights to connect to a server (encrypted connection only)HInfoDatabaseRights,
HModifyDatabaseRights
hRightsCreateDBRights to create a databaseHInfoServerRights,
HModifyServerRights
hRightsCreateFileRights to create a data file (with HCreation)HInfoDatabaseRights,
HModifyDatabaseRights
Versions 20 and later
hRightsCreateView
New in version 20
hRightsCreateView
hRightsCreateView
Rights to create a SQL view or a materialized view.HInfoDatabaseRights,
HModifyDatabaseRights
hRightsDebugRights to debug the stored procedures.HInfoDatabaseRights,
HModifyDatabaseRights
hRightsDisconnectClientRights to disconnect the client computers.HInfoServerRights,
HModifyServerRights
hRightsSendMessageToClientRights to send messages to the client computers.HInfoServerRights,
HModifyServerRights
hRightsRunProcedureRights to run the stored procedures.HInfoDatabaseRights,
HModifyDatabaseRights
hRightsManageDuplicateRights to enable and disable the management of duplicates.HInfoDatabaseRights,
HInfoFileRights,
HModifyDatabaseRights,
HModifyFileRights
hRightsManageIntegrityRights to enable and disable the management of integrity.HInfoDatabaseRights,
HModifyDatabaseRights
hRightsManageTaskRights to manage the scheduled tasks.HInfoServerRights,
HModifyServerRights
hRightsManageProcedureRights to add, modify and delete the stored procedures.HInfoDatabaseRights,
HModifyDatabaseRights
hRightsManageServerRights to use HSetServerHInfoServerRights,
HModifyServerRights
hRightsManageTriggerRights to manage the server triggers (addition, activation, deletion)HInfoDatabaseRights,
HModifyDatabaseRights
hRightsManageUserRights to delete and add users or groupsHInfoServerRights,
HModifyServerRights
hRightsNoDatabaseAccessRights to prevent access to a database (HNoDatabaseAccess and HEndNoDatabaseAccess)HInfoDatabaseRights,
HModifyDatabaseRights
hRightsReadRights to read the records of a data fileHInfoDatabaseRights,
HInfoFileRights,
HModifyDatabaseRights,
HModifyFileRights
hRightsReadLogStatRights to see the activity statistics and the server logs.HInfoServerRights,
HModifyServerRights
hRightsMaintenanceRights to start a re-index operation or to perform statistical calculations on a data fileHInfoDatabaseRights,
HInfoFileRights,
HModifyDatabaseRights,
HModifyFileRights
hRightsAutoModifRights to perform the automatic modification of the data files on a fileHInfoDatabaseRights,
HInfoFileRights,
HModifyDatabaseRights,
HModifyFileRights
hRightsUpdateRights to modify the records of a data fileHInfoDatabaseRights,
HInfoFileRights,
HModifyDatabaseRights,
HModifyFileRights
hRightsPriorityRights to modify the priority of a client applicationHInfoServerRights,
HModifyServerRights
Versions 18 and later
hRightsServerReplication
New in version 18
hRightsServerReplication
hRightsServerReplication
Rights to define and perform a replication between two HFSQL servers.HInfoServerRights,
HModifyServerRights
hRightsBackupRights to save the data filesHInfoDatabaseRights,
HInfoServerRights,
HModifyDatabaseRights,
HModifyServerRights
hRightsDeleteRights to delete the records from a data fileHInfoDatabaseRights,
HInfoFileRights,
HModifyDatabaseRights,
HModifyFileRights
hRightsDeleteDBRights to delete a databaseHInfoDatabaseRights,
HModifyDatabaseRights
hRightsDeleteFileRights to delete a data file (HDeleteFile)HInfoDatabaseRights,
HInfoFileRights,
HModifyDatabaseRights,
HModifyFileRights
Versions 20 and later
hRightsDeleteView
New in version 20
hRightsDeleteView
hRightsDeleteView
Rights to delete a SQL view or a materialized view.
Versions 20 and later
HInfoViewRights, HModifyViewRights
HInfoViewRights, HModifyViewRights
hRightsAllList of all the rightsHInfoDatabaseRights,
HInfoFileRights,
HInfoServerRights
hRightsSeeUserRights to view the characteristics of a group or user.HInfoServerRights,
HModifyServerRights
hlbDiskAccessValue modifying the coefficient applied to the counter for the number of disk accesses.HSetServer
hlbActiveEnable or disable the load balancingHSetServer
hlbClientCallsValue modifying the coefficient applied to the counter for client callsHSetServer
hlbMaxTimeoutValue modifying the maximum timeout for a server requestHSetServer
hlbDiskValue modifying the coefficient applied to the counter for the bytes read or written on disk by the serverHSetServer
hlbSentValue modifying the coefficient applied to the counter for the bytes sent by the serverHSetServer
hlbReceivedValue modifying the coefficient applied to the counter for the bytes received by the serverHSetServer
hWriteDefaultAddition not affecting the current browse/Identifier re-used or calculated for the recordHAdd, HWrite, HModify
hEffectiveThe rights returned correspond to the rights that will be actually granted to the user or to the group on the database. The inherited rights are taken into account (rights granted to the groups to which the user belongs for example).HInfoDatabaseRights,
HInfoFileRights,
HInfoServerRights
hOnUpdateIntegrity rule applied during a modificationHSetIntegrity
hRecFileRecord to read: Value of the item currently saved in the data fileHErrorModification, HErrorStatusModification
hRecReadRecord to read: Value of the item for the source recordHErrorModification, HErrorStatusModification
hRecUserRecord to read: Value of the item for the current record when performing the modificationHErrorModification, HErrorStatusModification
hOnDeleteIntegrity rule applied during a deletionHSetIntegrity
Versions 26 and later
heqaCanceled
New in version 26
heqaCanceled
heqaCanceled
Procedure for the end of the execution of the query: The procedure executed for each record returned False. The query and the different procedures were canceled.
Versions 26 and later
HExecuteQueryAsynchronous
New in version 26
HExecuteQueryAsynchronous
HExecuteQueryAsynchronous
Versions 26 and later
HExecuteSQLQueryAsynchronous
HExecuteSQLQueryAsynchronous
Versions 26 and later
heqaError
New in version 26
heqaError
heqaError
Procedure for the end of the execution of the query: The query and/or the procedure called for each record encountered an error.
Versions 26 and later
HExecuteQueryAsynchronous
New in version 26
HExecuteQueryAsynchronous
HExecuteQueryAsynchronous
Versions 26 and later
HExecuteSQLQueryAsynchronous
HExecuteSQLQueryAsynchronous
Versions 26 and later
heqaOK
New in version 26
heqaOK
heqaOK
Procedure for the end of the execution of the query: The query and the procedure were correctly executed for each record.
Versions 26 and later
HExecuteQueryAsynchronous
New in version 26
HExecuteQueryAsynchronous
HExecuteQueryAsynchronous
Versions 26 and later
HExecuteSQLQueryAsynchronous
HExecuteSQLQueryAsynchronous
hErrDatabaseAccessConfigure the access errors to an HFSQL Client/Server database.HOnError
hErrADOType of information about the error to return: Error code returned by ADO. The corresponding message is returned by the hErrADOMessage constant.HErrorInfo
hErrBaseType of information about the error to return: Error code returned by the database. The corresponding message is returned by the hErrBaseMessage constantHErrorInfo
hErrLockCustomize lock errorsHOnError
Versions 26 and later
hErrCode
New in version 26
hErrCode
hErrCode
Type of information about the error to return: Number of the last error raised by the HFSQL engine.HErrorInfo
hErrSystemCodeType of information about the error to return: Number of the associated system errorHErrorInfo
hErrFullDetailsType of information about the error to return: Full error details (error line, current process, etc.)
Remark: Returns the same information as the one retrieved via the "Copy" button in the WLanguage error window.
HErrorInfo
hErrDuplicatesCustomize duplicate errorsHOnError
hErrCurrentType of information about the error to return: Number of the current errorHError
Versions 20 and later
hErrorLastRefresh
New in version 20
hErrorLastRefresh
hErrorLastRefresh
Requested information: Last error while refreshing the materialized view.
Versions 20 and later
HInfoView
New in version 20
HInfoView
HInfoView
hErrFICType of information about the error to return: Full name of the data file associated with the errorHErrorInfo
hErrFileType of information about the error to return: Logical name of data file associated with the errorHErrorInfo
hErrLockInfoType of information about the error to return: Information about the lockHErrorInfo
hErrClientInfoInformation about the client layer used by the Native Connector that returned the error.HErrorInfo
hErrDebugInfoType of information about the error to return: Specific information for debugging the problem that occurred. HErrorInfo
hErrServerInfoInformation about the server used by the Native Connector that returned the error.HErrorInfo
hErrIntegrityCustomize integrity errorsHOnError
hErrLinkType of information about the error to return: Name of the link associated with the errorHErrorInfo
Versions 25 and later
hErrFicList
New in version 25
hErrFicList
hErrFicList
Type of information about the error to return: List of HFSQL files with errors.HErrorInfo
hErrMessageType of information about the error to return: Message associated with the errorHErrorInfo
hErrADOMessageType of information about the error to return: Message corresponding to the error returned by ADO (hErrADO)HErrorInfo
hErrBaseMessageType of information about the error to return: Message corresponding to the error returned by the database (hErrBase)HErrorInfo
hErrNativeMessageType of information about the error to return: Message corresponding to the error returned by the provider of the Native Connector.HErrorInfo
hErrOLEDBMessageType of information about the error to return: Message corresponding to the error returned by the system during an OLE DB connection (hErrOLEDB)HErrorInfo
hErrSystemMessageType of information about the error to return: Message of associated system errorHErrorInfo
hErrMMOType of information about the error to return: Full name of the memo file associated with the errorHErrorInfo
hErrModifyCustomize a modification conflictHOnError
hErrPasswordCustomize password errorsHOnError
hErrNativeType of information about the error to return: Error code returned by the Native Connector or the OLE DB provider usedHErrorInfo
hErrNDXType of information about the error to return: Full name of the index file associated with the errorHErrorInfo
hErrRecNumType of information about the error to return: Number of the record associated with the errorHErrorInfo
hErrOLEDBType of information about the error to return: Error code returned by the system during an access via an OLE DB connection.HErrorInfo
hErrConnectionLossCustomize the errors caused by a loss of connection with the server.HOnError
Versions 20 and later
hErrPositionSQLError
New in version 20
hErrPositionSQLError
hErrPositionSQLError
Type of information about the error to return: Position of the SQL error in the SQL code of the query run by HExecuteSQLQuery.HErrorInfo
hErrMainType of information about the error to return: Number of the main errorHError
hErrIndexCustomize reindexing errors (reindexing in progress when accessing the data file)HOnError
hErrItemType of information about the error to return: Name of the item associated with the errorHErrorInfo
hErrServerType of information about the error to return: Name of the HFSQL Client/Server server that triggers the errorHErrorInfo
hErrAllCustomize all errorsHOnError
hErrNeedValueCustomize errors caused by a required value that has not been specified (OLE DB only).HOnError
hErrWDDType of information about the error to return: Full name of the analysis file associated with the errorHErrorInfo
hStateActiveStatus of the record/Type of record taken into account: Active recordHState, hNbRec, HErrorStatusModification
hStateInvalidRecord status not found (error)HState, HErrorStatusModification
hStateCrossedStatus of the record/Type of record taken into account: Crossed recordHState, hNbRec, HErrorStatusModification
hStateDelStatus of the record/Type of record taken into account: Deleted recordHState, hNbRec, HErrorStatusModification
hStateAllType of record: Total number of records in the data filehNbRec
hExistingType of search: Only the assignments for which a file actually existsHListREP
hExpCreationMode for creating the export file: The file is overwritten if it already exists.HExportXML
Versions 21 and later
HExportJSON
New in version 21
HExportJSON
HExportJSON
Versions 24 and later
HExportCSV
New in version 24
HExportCSV
HExportCSV
Versions 24 and later
HExportXLS
New in version 24
HExportXLS
HExportXLS
hExpBreakableMode for creating the export file: The export can be interrupted by pressing Esc.
If the export is interrupted, the export file is valid and it only contains the records exported before the interruption.
HExportXML
Versions 21 and later
HExportJSON
New in version 21
HExportJSON
HExportJSON
Versions 24 and later
HExportCSV
New in version 24
HExportCSV
HExportCSV
Versions 24 and later
HExportXLS
New in version 24
HExportXLS
HExportXLS
hExpNormalMode for creating the export file: Standard operating modeHExportXML
Versions 21 and later
HExportJSON
New in version 21
HExportJSON
HExportJSON
Versions 24 and later
HExportCSV
New in version 24
HExportCSV
HExportCSV
Versions 24 and later
HExportXLS
New in version 24
HExportXLS
HExportXLS
Versions 24 and later
hExpNoLineItemName
New in version 24
hExpNoLineItemName
hExpNoLineItemName
Mode for creating the CSV/XLSX file: The first line of the generated file will not contain the names of the items.
Versions 24 and later
HExportCSV
New in version 24
HExportCSV
HExportCSV
Versions 24 and later
HExportXLS
New in version 24
HExportXLS
HExportXLS
hExpWithoutXSLThe style sheet (".XSL" file) is not createdHExportXML
Versions 24 and later
hFalsifyTimestamp
New in version 24
hFalsifyTimestamp
hFalsifyTimestamp
Management of Timestamp items: By default, a Timestamp item contains the date and time the record was created/modified. This date/time is automatically calculated.
This constant prevents the Timestamp item from being updated: the last value in the record will be kept.
HAdd, HModify
hFileAS400Type of file: AS400 fileType property
hFileOtherType of file: Other type of fileType property
hFileClientServerType of file: HFSQL Client/Server fileType property
hFileHF5Type of file: Hyper File 5 fileType property
hFileMySQLType of file: MySQL fileType property
hFileNormalType of file: Standard file (HFSQL Classic)Type property
hFileOLEDBType of file: OLEDB fileType property
hFileOracleType of file: ORACLE fileType property
hFileOracleLiteType of file: ORACLE Lite fileType property
Versions 15 and later
hFilePostgreSQL
New in version 15
hFilePostgreSQL
hFilePostgreSQL
Type of file: PostgreSQL fileType property
hFileProgressType of file: Progress fileType property
hFileQueryType of file: QueryType property
hFileQueryAS400Type of file: Query on an AS/400 databaseType property
hFileQueryClientServerType of file: Query on an HFSQL Client/Server databaseType property
hFileQueryMySQLType of file: Query on a MySQL databaseType property
hFileQueryOLEDBType of file: Query on a database accessed via an OLE DB providerType property
hFileQueryOracleType of file: Query on an Oracle databaseType property
hFileQueryOracleLiteType of file: Query on an Oracle Lite databaseType property
Versions 15 and later
hFileQueryPostgreSQL
New in version 15
hFileQueryPostgreSQL
hFileQueryPostgreSQL
Type of file: Query on a PostgreSQL databaseType property
hFileQueryProgressType of file: Query on a Progress databaseType property
Versions 16 and later
hFileQuerySQLAzure
New in version 16
hFileQuerySQLAzure
hFileQuerySQLAzure
Type of file: Query on an SQL Azure databaseType property
hFileQuerySQLServerType of file: Query on an SQL Server databaseType property
hFileQuerySQLServerMobileType of file: Query on an SQL Server Mobile databaseType property
hFileQuerySybaseType of file: Query on a Sybase databaseType property
hFileQueryXMLType of file: Query on an XML databaseType property
hFileSQLType of file: SQL fileType property
Versions 16 and later
hFileSQLAzure
New in version 16
hFileSQLAzure
hFileSQLAzure
Type of file: SQL Azure fileType property
Versions 16 and later
hFileSQLite
New in version 16
hFileSQLite
hFileSQLite
Type of file: SQLite fileType property
hFileSQLServerType of file: SQL Server fileType property
hFileSQLServerMobileType of file: SQL Server Mobile fileType property
hFileSybaseType of file: Sybase fileType property
hFileTemporaryType of file: Temporary fileType property
hFileViewType of file: HFSQL viewType property
hFileXBaseType of file: xBase fileType property
hFileXMLType of file: XML fileType property
hSetIDAutoMode for calculating the automatic identifier: Identifier value equals to the one stored during the additionHAdd, HWrite, HModify
hSetIDAutoMode for calculating the automatic identifier: Identifier value equals to the one stored during the write operationHAdd, HWrite, HModify
hANSIFormatData format: Ansi format (used by Windows)Format property
hUNICODEFormatData format: UNICODE formatFormat property
Versions 17 and later
hForwardOnly
New in version 17
hForwardOnly
hForwardOnly
Native Connectors only:
Allows looping through records faster.
HReadLast,
HReadFirst,
HReadSeekFirst,
HReadSeekLast
Versions 20 and later
hftPunctuationSimple
New in version 20
hftPunctuationSimple
hftPunctuationSimple
Full-text Index item described programmatically: Taking into account the simple punctuation characters (non Unicode).Option property of FullTextIndex Description variables.
Versions 20 and later
hftPunctuationUnicode
New in version 20
hftPunctuationUnicode
hftPunctuationUnicode
Full-text Index item described programmatically: Taking into account the Unicode punctuation characters.Option property of FullTextIndex Description variables.
hFTXReindexing full-text indexesHIndex
HGenericType of search: Generic searchHReadSeekLast,
HReadSeekFirst,
HSeekLast,
HSeekFirst
hHCreationIfNotFoundType of test to run to check the connection: Checks the connection by opening or creating a file (if the file does not exist). This operation can be performed in hOReadWrite mode only.HConnect
hInheritThe user will inherit from the value of the rights granted to the group to which he belongsHModifyDatabaseRights,
HModifyFileRights,
HModifyServerRights
hHOpenType of test to run to check the connection: Checks the connection by opening a file. This value is used by default when accessing to an hORead database.HConnect
hIdenticalThe structures of files (read in the analysis and in the physical file) must be strictly identical.HReadSeek, HSeek, HCheckStructure
hIgnoreDuplicatesDoes not check for duplicates for this action, even if the automatic duplicate check is enabled (HSetDuplicates)HAdd
hIgnoreIntegrityIgnores the integrity check for this operation, even if the automatic integrity check is enabled (HSetIntegrity)HAdd, HModify, HDelete, HCross
hImpConversionType of import: The associated items do not have the same type or the same size: the data checked out from the imported file is automatically converted or truncated.HImportHF55
hImpCreationType of import: If the (HFSQL Classic) import file exists, it is overwritten.HImportHF55,
HImportText,
Versions 20 and later
HImportXLS,
New in version 20
HImportXLS,
HImportXLS,
HImportXML
Versions 21 and later
HImportJSON
New in version 21
HImportJSON
HImportJSON
hImpIgnoreInvalidLineType of import: The lines whose structure are invalid are not imported: the import continues on the following lines. The structure is invalid if data is missing for one or more items, or if string separators are missing.HImportText,
Versions 20 and later
HImportXLS
New in version 20
HImportXLS
HImportXLS
Versions 20 and later
hImpIgnoreFirstLine
New in version 20
hImpIgnoreFirstLine
hImpIgnoreFirstLine
Type of import: The first row of the imported file is ignored.HImportText,
Versions 20 and later
HImportXLS
New in version 20
HImportXLS
HImportXLS
hImpIgnoreItemType of import:
  • The items found in the import file (HFSQL Classic) without associated items in the imported file (Hyper File 5.5) are filled with their default value.
  • The items of imported file (Hyper File 5.5) with no match in the import file are ignored.
HImportHF55
hImpIgnoreEmptyItemIf one or more items are not filled in the text file, the corresponding lines are still imported.
The missing items contain:
  • the default value of items if the hDefaultVal constant is specified.
  • the value of items in the current record before the call to HImportText.
HImportText,
Versions 20 and later
HImportXLS
New in version 20
HImportXLS
HImportXLS
hImpBreakableThe import can be interrupted by pressing ESC.HImportHF55,
HImportText,
Versions 20 and later
HImportXLS,
New in version 20
HImportXLS,
HImportXLS,
HImportXML
Versions 21 and later
HImportJSON
New in version 21
HImportJSON
HImportJSON
hImpNormalType of import: The import is not performed and an error occurs in the following cases:
  • items found in the Hyper File 5.5 file with no match in the HFSQL Classic file.
  • associated items in the two files but with a different size and/or format.
HImportHF55,
HImportText,
Versions 20 and later
HImportXLS,
New in version 20
HImportXLS,
HImportXLS,
HImportXML
Versions 21 and later
HImportJSON
New in version 21
HImportJSON
HImportJSON
hImpOEM2ANSIType of import: Convert the imported strings from OEM to ANSI. This constant is available for backward compatibility.HImportText
hImpNoDelimiterType of import: The string separators (if they exist) are part of the itemHImportText
hImpNoSpaceType of import: The space characters found at the end of string are automatically deleted during the importHImportHF55
hImpTestDuplicatesType of import: Checks the duplicates during the importHImportHF55,
HImportText,
Versions 20 and later
HImportXLS
New in version 20
HImportXLS
HImportXLS
hImpTestIntegrityType of import: Checks the integrity during the importHImportHF55,
HImportText,
Versions 20 and later
HImportXLS
New in version 20
HImportXLS
HImportXLS
hInaccessibleUndefined server statusHServerStatus
Versions 15 and later
hInfoCluster
New in version 15
hInfoCluster
hInfoCluster
Information about the HFSQL cluster.HInfoServer
hInfoDateDate and time of server on 8 bytes in UTC format (universal time)HInfoServer
Versions 22 and later
hInfoFreeDiskSpace
New in version 22
hInfoFreeDiskSpace
hInfoFreeDiskSpace
Available space on the server disk, expressed in MB.HInfoServer
Versions 22 and later
hInfoTotalDiskSpace
New in version 22
hInfoTotalDiskSpace
hInfoTotalDiskSpace
Total capacity of server disk, expressed in MB.HInfoServer
hInfoHardwareInformation about the hardware used.HInfoServer
hInfoNameName of server (DNS)HInfoServer
hInfoLogicalNameName of server given in HFConf.ini or specified during the setup. HInfoServer
hInfoPlatformInformation about the server platform.HInfoServer
Versions 19 and later
hInfoSizeCacheNdxUsed
New in version 19
hInfoSizeCacheNdxUsed
hInfoSizeCacheNdxUsed
Size of index cache that is actually used on the server, expressed in MB.HInfoServer
hInfoAllFull server details.HInfoServer
hInfoVersionInformation about the version of programs required for the server to operate.HInfoServer
hInfoVersionDetailsDetailed information about the version of the programs required to operate the server.HInfoServer
hInfoVIVersion number of Manta.exe or Manta in LinuxHInfoServer
hIntegrityNoneModification/Deletion rule: No integrity managementModificationRule property, DeletionRule property
hIntegrityCascadeModification/Deletion rule: Cascading modification/deletionModificationRule property, DeletionRule property
hIntegrityForbiddenModification/Deletion rule: Modification/Deletion not allowedModificationRule property, DeletionRule property
hIntegrityDefaultValueModification/Deletion rule: Default modification/deletionModificationRule property, DeletionRule property
hForbiddenThe relevant rights are not granted to the user or groupHModifyDatabaseRights,
HModifyFileRights,
HModifyServerRights
hLogJNLFileConfigures the file to recreate: Only <File name>JNL.FIC is recreated.HLogRecreate
hLogIdentificationConfigures the file to recreate: Re-creates the "JournalIdentification.fic" file.HLogRecreate
hLogWritingFormat of log process: Log the write operations performed in the fileLogMethod property
hLogReadingWritingFormat of log process: Log the read and write operations performed in the fileLogMethod property
hLogNoFormat of log process: No logLogMethod
hLogOperationConfigures the file to recreate: Re-creates the "JournalOperation.fic" file.HLogRecreate
hLogUserConfigures the file to recreate: Recreates the log of users ("UserLog.fic").
This file exists in HFSQL Client/Server only. This file contains the information (login, computer, ...) about the users who perform the logged actions.
HLogRecreate
Versions 23 and later
hkaInterval
New in version 23
hkaInterval
hkaInterval
Maximum time (in seconds) after which, if no communication is established between the server and the client, the server will check the presence of client. HSetServer
Versions 23 and later
hkaTimeout
New in version 23
hkaTimeout
hkaTimeout
Maximum timeout (in seconds) for the server when checking the presence of client. If the client is not found at the end of this timeout, the client is automatically disconnected. HSetServer
hLanguageCreationUsed to find out whether the language used to perform the comparisons and the sort corresponds to "Defined at creation".Language property, LanguageDescribed property
Versions 17 and later
hLanguageBinarySort
New in version 17
hLanguageBinarySort
hLanguageBinarySort
The sort will be performed by comparing the binary value of the bytes. This type of sort is very fast. Language property, LanguageDescribed property, H.LanguageCreationUnicode property
Versions 17 and later
hLanguageFastSort
New in version 17
hLanguageFastSort
hLanguageFastSort
The sort will be performed by comparing the characters one by one according to a generic sort.Language property, LanguageDescribed property, H.LanguageCreationUnicode property
hLimitParsingLimits the file browse: The browse will stop as soon as the last sought value is found.HReadSeek, HReadSeekLast, HReadSeekFirst, HSeek, HSeekLast, HSeekFirst
Versions 22 and later
hlpCalcStat
New in version 22
hlpCalcStat
hlpCalcStat
Type of operation performed on the server: statistical calculation.
Versions 22 and later
hServerOperation type
New in version 22
hServerOperation type
hServerOperation type
Versions 22 and later
hlpKeyDetection
New in version 22
hlpKeyDetection
hlpKeyDetection
Type of operation performed on the server: detection of keys.
Versions 22 and later
hServerOperation type
New in version 22
hServerOperation type
hServerOperation type
Versions 20 and later
hlpOptimization
New in version 20
hlpOptimization
hlpOptimization
Type of scheduling to list: Tasks for optimizing files (re-indexing, statistical calculation).
Versions 22 and later
hlpReplication
New in version 22
hlpReplication
hlpReplication
Type of operation performed on the server: server replication.
Versions 22 and later
hServerOperation type
New in version 22
hServerOperation type
hServerOperation type
Versions 20 and later
hlpBackup
New in version 20
hlpBackup
hlpBackup
Type of scheduling to list: Scheduling of backups.
Versions 20 and later
hlpTask
New in version 20
hlpTask
hlpTask
Type of scheduling to list: Scheduled tasks that run a stored procedure.
Versions 20 and later
hlpMaterializedView
New in version 20
hlpMaterializedView
hlpMaterializedView
Type of scheduling to list: Tasks for refreshing the materialized views.
hLstKeyLists the key itemsHListKey, HListItem
hLstCompositeKeyLists the composite key items onlyHListKey, HListItem
hLstSetLists the sets of procedures found on a serverHListStoredElement
hLstDetailLists the detailed informationHListKey, HListFile,
HListLink, HListItem, HListConnection,
HListStoredElement
hLstDetailPlusFor the numeric items or keys, adds to the detailed information the number of digits found in the integer part and in the decimal part.HListKey, HListItem
hLstFileLists the databases and their files for the server defined by the connectionHListDatabase
hLstMemoLists the memo itemsHListItem
hLstNormalLists all keys/List not sorted, not detailed, without the files described dynamically/List of links/Lists the items (except for composite key items)/List of connections, not sorted, not detailed, without the connections described dynamically.HListKey, HListFile, HListItem, HListConnection
hLstLogicalOrderLists the items or the keys according to the logical order of itemsHListKey, HListItem
hLstOpenedStores the opened connections onlyHListConnection
hLstStoredProcedureLists the stored procedures of a connection via Native Connectors or OLE DBHListFile,
HListStoredElement
hLstQuery
  • Lists the queries found on a server
  • Versions 19 and later
    Lists the queries that have been run.
    New in version 19
    Lists the queries that have been run.
    Lists the queries that have been run.
hLstItemLists the non-key and non-memo itemsHListItem
hLstOriginalItemUsed on a log file (xxxJNL.fic), lists the items of the source file (that was logged). For example, on CustomerLOG.Fic, lists the items of CUSTOMER file.HListKey, HListItem
hLstTableList of user tables for a connection via Native Connectors or OLE DBHListFile
hLstSystemTableList of system tables for a connection via Native Connectors or OLE DBHListFile
Versions 22 and later
hLstDatabaseSize
New in version 22
hLstDatabaseSize
hLstDatabaseSize
List of connection databases as well as their size. HListDatabase
hLstAllLists all the keys, all the files, all the items or all the connectionsHListKey, HListFile, HListItem, HListConnection,
HListStoredElement
hLstSortedSorts the list of keys, files, items or connection in ascending orderHListKey, HListFile, HListItem, HListConnection
hLstView
  • List the views of a connection via Native Connectors or OLE DB.
  • Versions 20 and later
    List the SQL views on an HFSQL server.
    New in version 20
    List the SQL views on an HFSQL server.
    List the SQL views on an HFSQL server.
HListFile
Versions 20 and later
hLstMaterializedView
New in version 20
hLstMaterializedView
hLstMaterializedView
Lists the materialized views found on an HFSQL server.HListFile
hComputerProperty of a database found on an HFSQL server: Name of the computer from which the element was created.HInfoDatabaseProperty, HInfoFileProperty
hMemoAutoThe memos are read during the access to the itemHSetMemo
hMemoBinType of file used for the memo: Any binary fileHLinkMemo
hMemoImgType of file used for the memo: Image fileHLinkMemo
hMemoNoNo management of memosHSetMemo
hMemoOleType of file used for the memo: OLE fileHLinkMemo
hMemoYesThe text memos are read whenever the record is read.
Read the binary memos when accessing the item.
HSetMemo
hMemoWavType of file used for the memo: sound fileHLinkMemo
hMessageConfigures the information messageHOnServerCall
hMode2GBIndicates whether system files support more than 2 GBHSetServer
Versions 20 and later
hMmoCompact
New in version 20
hMmoCompact
hMmoCompact
Compression and defragmentation of "Mmo" files.HIndex
hModeDirectPriority implementation of locksHMode
hModeMonoSingle-user lock modeHMode
hModeMultiMulti-user lock modeHMode
hModeReservationNon-priority implementation of locksHMode
hModifyFileWhen modifying the query result, these modifications will be applied to the files belonging to the query.
If this option is not specified, only the query result is modified.
HExecuteQuery, HExecuteSQLQuery
Versions 17 and later
hmsNormal
New in version 17
hmsNormal
hmsNormal
Standard operating mode of the automatic data modification.
Versions 17 and later
HModifyStructure
New in version 17
HModifyStructure
HModifyStructure
Versions 17 and later
hmsNoCheck
New in version 17
hmsNoCheck
hmsNoCheck
The automatic data modification is performed even if the file description is more recent than the analysis description.
Versions 17 and later
HModifyStructure
New in version 17
HModifyStructure
HModifyStructure
Versions 17 and later
hmsBackgroundTask
New in version 17
hmsBackgroundTask
hmsBackgroundTask
A hot automatic modification is performed (available for the HFSQL Client/Server data files only).
Versions 17 and later
HModifyStructure
New in version 17
HModifyStructure
HModifyStructure
hNdxCompactReindexing with compressionHIndex
hNdxMinimalReindex and ignore corrupted keysHIndex
hNdxSilentConfigure reindexing: No display during reindexingHIndex
hNdxNormalStandard reindexingHIndex
hNdxNoStatReindex without calculating statisticsHIndex
hNdxDeleteReindex and delete damaged recordsHIndex
hLogLevelDefines the elements that must be in the log fileHSetServer
Versions 24 and later
hMaxNumberConnection
New in version 24
hMaxNumberConnection
hMaxNumberConnection
Maximum number of connections allowed per application. HSetServer
hNonBlockingNumber of records retrieved in the view or query without waiting for the view or query to be entirely filled. hNbRec
hNotAKeyCharacteristics of an item: Non-key itemKeyType property
hNotReplicatedReplication mode: The data file is not configured for replication. To implement the replication, check "Replication" in the characteristics of the file in the data model editor.Replication property
hNotSortedSort direction: Item not sortedSortType property
hNotesProperty of a database found on an HFSQL server: Database description or any other information associated with the database by HModifyDatabaseProperty.HInfoDatabaseProperty, HInfoFileProperty, HInfoServerProperty, HModifyDatabaseProperty, HModifyFileProperty, HModifyServerProperty
Versions 18 and later
hNotifWarning
New in version 18
hNotifWarning
hNotifWarning
The notifications will be sent from the warning level (for the warning, critical and error problems).HNotifAddCCRecipient, HNotifAddEmailRecipient
Versions 18 and later
hNotifCCClassic
New in version 18
hNotifCCClassic
hNotifCCClassic
The notifications are sent by the Control Centers in HFSQL Classic mode.
Versions 18 and later
HNotifConfigure
New in version 18
HNotifConfigure
HNotifConfigure
Versions 18 and later
hNotifCCCS
New in version 18
hNotifCCCS
hNotifCCCS
The notifications are sent by the Control Centers in Client/Server mode.
Versions 18 and later
HNotifConfigure
New in version 18
HNotifConfigure
HNotifConfigure
Versions 18 and later
hNotifCritical
New in version 18
hNotifCritical
hNotifCritical
The notifications will be sent from the critical level (for the critical and error problems).HNotifAddCCRecipient, HNotifAddEmailRecipient
Versions 18 and later
hNotifEmail
New in version 18
hNotifEmail
hNotifEmail
The notifications are sent by email.
Versions 18 and later
HNotifConfigure
New in version 18
HNotifConfigure
HNotifConfigure
Versions 18 and later
hNotifError
New in version 18
hNotifError
hNotifError
The notifications will be sent for the error problems only.HNotifAddCCRecipient, HNotifAddEmailRecipient
Versions 22 and later
hNotifInformation
New in version 22
hNotifInformation
hNotifInformation
The notifications will be sent from the information level (for the information, warning, critical and error problems)HNotifAddCCRecipient, HNotifAddEmailRecipient
hCurrentRecNumNumber of the current record.HFSQL functions
hInvalidRecNumConstant returned if there is no current record or if the specified file corresponds to a multi-file query.HRecNum
Versions 22 and later
hRecNumAll
New in version 22
hRecNumAll
hRecNumAll
  • Used to track all records found in a data file.
  • Versions 23 and later
    Used to check all unaltered records
    New in version 23
    Used to check all unaltered records
    Used to check all unaltered records
hODBCOLE DB provider that will be used for the connection: OLE DB provider for ODBC. Allows you to access an ODBC source declared in the ODBC data sources of WindowsCtOLEDBProvider property, CtDescribedOLEDBProvider property,
HConnect, HDeclareExternal, HListFile, HOpenConnection, SQLConnect
hOReadFile accessible in read-onlyCtAccess property, CtDescribedAccess property,
HConnect, HOpen
hOReadWriteFile accessible in read/writeCtAccess property, CtDescribedAccess property,
HConnect, HOpen
hOledbAccess97OLE DB provider that will be used for the connection: OLE DB provider for Access 97CtOLEDBProvider property, CtDescribedOLEDBProvider property,
HConnect, HDeclareExternal, HListFile, HOpenConnection, SQLConnect
hOledbAccess2000OLE DB provider that will be used for the connection: OLE DB provider for Access 2000CtOLEDBProvider property, CtDescribedOLEDBProvider property,
HConnect, HDeclareExternal, HListFile, HOpenConnection, SQLConnect
hOledbAccess2007OLE DB provider that will be used for the connection: OLE DB provider for Access 2007CtOLEDBProvider property, CtDescribedOLEDBProvider property,
HConnect, HDeclareExternal, HListFile, HOpenConnection, SQLConnect
Versions 19 and later
hOledbAccess2010
New in version 19
hOledbAccess2010
hOledbAccess2010
OLE DB provider that will be used for the connection: OLE DB provider for Access 2010CtOLEDBProvider property, CtDescribedOLEDBProvider property,
HConnect, HDeclareExternal, HListFile, HOpenConnection, SQLConnect
hOledbDBase5OLE DB provider that will be used for the connection: OLE DB provider for dBase 5CtOLEDBProvider property, CtDescribedOLEDBProvider property,
HConnect, HDeclareExternal, HListFile, HOpenConnection, SQLConnect
hOledbExcel2000OLE DB provider that will be used for the connection: OLE DB provider for Excel 2000CtOLEDBProvider property, CtDescribedOLEDBProvider property,
HConnect, HDeclareExternal, HListFile, HOpenConnection, SQLConnect
hOledbExcel2007OLE DB provider that will be used for the connection: OLE DB provider for Excel 2007CtOLEDBProvider property, CtDescribedOLEDBProvider property,
HConnect, HDeclareExternal, HListFile, HOpenConnection, SQLConnect
hOledbExcel97OLE DB provider that will be used for the connection: OLE DB provider for Excel 97CtOLEDBProvider property, CtDescribedOLEDBProvider property,
HConnect, HDeclareExternal, HListFile, HOpenConnection, SQLConnect
hOledbLotus4OLE DB provider that will be used for the connection: OLE DB provider for Lotus 4CtOLEDBProvider property, CtDescribedOLEDBProvider property,
HConnect, HDeclareExternal, HListFile, HOpenConnection, SQLConnect
hOledbOracleOLE DB provider that will be used for the connection: OLE DB provider for OracleCtOLEDBProvider property, CtDescribedOLEDBProvider property,
HConnect, HDeclareExternal, HListFile, HOpenConnection, SQLConnect
hOledbSQLServerOLE DB provider that will be used for the connection: OLE DB provider for SQL ServerCtOLEDBProvider property, CtDescribedOLEDBProvider property,
HConnect, HDeclareExternal, HListFile, HOpenConnection, SQLConnect
Versions 15 and later
hOptIndex
New in version 15
hOptIndex
hOptIndex
Optimization options: Provokes the re-indexing operation on the data files. A hot re-indexing operation is performed on the indexes and on the full-text indexes.hFileParameter variable
Versions 15 and later
hOptStat
New in version 15
hOptStat
hOptStat
Optimization options: Provokes the recalculation of statistics on the data files.hFileParameter variable
hDelayedOpeningOptimize the opening of existing files: If the file already exists, it will be opened during the first access to the file. The file is created if it does not exist.HCreationIfNotFound
Versions 24 and later
hBrowsableNonBlocking
New in version 24
hBrowsableNonBlocking
hBrowsableNonBlocking
Number of records in the view or query that can currently be read (no record locking). HNbRec
hActivityStatisticsPeriodIndicates the period (in second) between each backup of values for the different activity counters.HSetServer
hDebuggingPortPort used to debug the stored procedures and the server triggers.HSetServer
hServerPortNetwork port usedHSetServer
hPrecisionHighPosition with high precisionHGetCurrentPosition, HSetPosition
hPrecisionLowPosition with low precisionHGetCurrentPosition, HSetPosition
hPrecisionMediumPosition with medium precisionHGetCurrentPosition, HSetPosition
hOwnerProperty of a database found on an HFSQL server: Owner of database.HInfoDatabaseProperty, HInfoFileProperty, HModifyDatabaseProperty, HModifyFileProperty
Versions 20 and later
hRefreshInProgress
New in version 20
hRefreshInProgress
hRefreshInProgress
Requested information: Is the materialized view currently refreshed?
Versions 20 and later
HInfoView
New in version 20
HInfoView
HInfoView
Versions 19 and later
hReadCommitted
New in version 19
hReadCommitted
hReadCommitted
Isolation level of transaction: other users can only view completed transactions.
Versions 19 and later
HTransactionIsolation
New in version 19
HTransactionIsolation
HTransactionIsolation
Versions 19 and later
hReadUncommitted
New in version 19
hReadUncommitted
hReadUncommitted
Isolation level of transaction: other users can view incomplete transactions.
Versions 19 and later
HTransactionIsolation
New in version 19
HTransactionIsolation
HTransactionIsolation
hRecalculateIDAutoMode for calculating the automatic identifier: Automatic identifier re-calculated during the write operationHWrite, HModify, HSave
Versions 22 and later
hFindKey
New in version 22
hFindKey
hFindKey
Enable the search for keys on the HFSQL server. HSetServer
Versions 19 and later
hRepeatableRead
New in version 19
hRepeatableRead
hRepeatableRead
Isolation level of transaction: the application in transaction sees a snapshot of the database when the transaction starts.
Versions 19 and later
HTransactionIsolation
New in version 19
HTransactionIsolation
HTransactionIsolation
hSubscriberReplicaReplication mode: The data file is a subscriber replica (HCreateSubscriberReplica was used to create the subscriber replica)Replication property
hMasterReplicaReplication mode: The data file is a master replica (HCreateMasterReplica was used to create the master replica)Replication property
hReplicatedReplication mode: The data file is configured to be replicated.Replication property
hQueryDefaultThe query is initialized without interruptionHExecuteQuery, HExecuteSQLQuery
hQueryBreakableThe query initialization can be interrupted with the ESC keyHExecuteQuery, HExecuteSQLQuery
hQueryWithoutCorrectionNative Connector or OLE DB only:
No check is performed by the HFSQL engine. This option must be used if the query contains commands specific to a connection type (Oracle, SQL Server, etc.)
HExecuteQuery, HExecuteSQLQuery
hQueryWithoutHFCorrectionHFSQL only
The file format (filled with space characters or not) is not checked by the HFSQL engine. To be used if the query handles both HFSQL files in a format that fills items with space characters and HFSQL files in a format that does not fill items with space characters.
HExecuteQuery, HExecuteSQLQuery
Versions 17 and later
hTempDirectory
New in version 17
hTempDirectory
hTempDirectory
Path of temporary directory. This directory is used to create the temporary files if necessary (temporary files created when re-indexing large data files for example).HSetServer
hKeepFilterThe filter set by HFilter will be taken into account, even if the search key is not optimized for the filter.
Reminder: HFilter returns the search key optimized for the filter.
Caution: in this case, performance problems may occur on large files.
HChangeKey, HLast, HReadLast, HReadFirst, HReadSeekLast, HReadSeekFirst, HReadSeek, HFirst, HSeek, HSeekLast, HSeekFirst
hRPKeepConfigure the restore operation: Position not freedHRestorePosition
hRPDefaultConfigure the restore operation: Position freed. The stored position is restoredHRestorePosition
hRPFilterConfigure the restore operation: Restore the filter set when HSavePosition is calledHRestorePosition
hRPHF5Configure the restore operation: If the stored position was deleted or modified, this position is restoredHRestorePosition
Versions 22 and later
hrsCopy
New in version 22
hrsCopy
hrsCopy
Configure the replication between servers: Enables the initial copy of replicated elements from the connection server (master server) to the other server (subscriber server, defined in the hRSConfig variable). This copy is locking. HRSAddConfig
Versions 22 and later
hrsCopyBackgroundTask
New in version 22
hrsCopyBackgroundTask
hrsCopyBackgroundTask
Configure the replication between servers: Enables the initial copy of replicated elements from the connection server (master server) to the other server (subscriber server, defined in the hRSConfig variable). This copy is performed in background task and it is not locking. HRSAddConfig
Versions 22 and later
hrsNoCopy
New in version 22
hrsNoCopy
hrsNoCopy
Configure the replication between servers: No copy is performed.HRSAddConfig
hItemBinaryItem type: BinaryType property
hItemBooleanItem type: BooleanType property
hItemCharacterItem type: CharacterType property
Versions 20 and later
hItemCombination
New in version 20
hItemCombination
hItemCombination
Item type: CombinationType property
hItemDate6Item type: DateType property
hItemDate8Item type: DateType property
hItemDateTimeItem type: Date/TimeType property
hItemTimeLengthItem type: DurationType property
hItemInteger1Item type: 1-byte integerType property
hItemInteger2Item type: 2-byte integerType property
hItemInteger4Item type: 4-byte integerType property
hItemInteger8Item type: 8-byte integerType property
hItemUnsignedInteger1Item type: Unsigned 1-byte integerType property
hItemUnsignedInteger2Item type: Unsigned 2-byte integerType property
hItemUnsignedInteger4Item type: Unsigned 4-byte integerType property
hItemUnsignedInteger8Item type: Unsigned 4-byte integerType property
Versions 20 and later
hItemEnumeration
New in version 20
hItemEnumeration
hItemEnumeration
Item type: EnumerationType property
hItemHourItem type: TimeType property
hItemIDAutoItem type: Automatic identifier (8 bytes)Type property
hItemIDAuto4Item type: Automatic identifier (4 bytes)Type property
hItemPictureItem type: ImageType property
hItemInvalidInvalid type of itemType property
Versions 24 and later
hItemJSON
New in version 24
hItemJSON
hItemJSON
Item type: JSONType property
hItemBinaryMemoItem type: Binary MemoType property
hItemBinaryMemo4Item type: Binary memo (4 bytes)Type property
hItemTextMemoItem type: Text MemoType property
hItemUnicodeMemoItem type: Unicode Text MemoType property
hItemCurrencyItem type: CurrencyType property
Versions 27 and later
hItemSecurePassword
New in version 27
hItemSecurePassword
hItemSecurePassword
Item type: PasswordType property
hItemNumRecItem type: Record numberType property
hItemNumericItem type: High-precision numericType property
hItemReal4Item type: 4-byte realType property
hItemReal8Item type: 8-byte realType property
hItemRealTurboItem type: Turbo realType property
hItemTextItem type: TextType property
hItemUnicodeTextItem type: Unicode textType property
Versions 24 and later
hItemUUID128
New in version 24
hItemUUID128
hItemUUID128
Item type: UUID 128Type property
Versions 24 and later
hItemUUID128Auto
New in version 24
hItemUUID128Auto
hItemUUID128Auto
Item type: UUID 128 automatic identifierType property
Versions 24 and later
hItemUUID256
New in version 24
hItemUUID256
hItemUUID256
Item type: UUID 256Type property
Versions 24 and later
hItemUUID256Auto
New in version 24
hItemUUID256Auto
hItemUUID256Auto
Item type: UUID 256 automatic identifierType property
Versions 22 and later
hsAdd
New in version 22
hsAdd
hsAdd
Monitors the operations for adding records.
Versions 22 and later
HTrack
New in version 22
HTrack
HTrack
Versions 22 and later
hsModification
New in version 22
hsModification
hsModification
Monitors the operations for modifying records.
Versions 22 and later
HTrack
New in version 22
HTrack
HTrack
Versions 22 and later
hsCross
New in version 22
hsCross
hsCross
Monitors the operations for crossing records.
Versions 22 and later
HTrack
New in version 22
HTrack
HTrack
Versions 22 and later
hsDeletion
New in version 22
hsDeletion
hsDeletion
Monitors the operations for deleting records.
Versions 22 and later
HTrack
New in version 22
HTrack
HTrack
Versions 20 and later
NoWait
New in version 20
NoWait
NoWait
The refresh of materialized view is not a locking operation: it is performed in background task. HInfoView returns the information of the materialized view after being refreshed.
Versions 20 and later
HRefreshView
New in version 20
HRefreshView
HRefreshView
hNoBindRun a query without enabling the bindHExecuteQuery, HExecuteSQLQuery,
HPrepareSQLQuery
hNoCheckNo check is performed, the analysis description may differ from the description of physical file.HCheckStructure
hNoIndexThe file index is not copiedHCopyFile
hNoLinkManagement of integrity: The links are not updated on the server (creation, modification or deletion).
Reminder: by default, the links are updated on the server when creating a file.
HCreation, HCreationIfNotFound
hNoRefreshThe table or query content will not be refreshedHLast, HReadLast, HReadFirst, HFirst
Versions 21 and later
hNoHourglass
New in version 21
hNoHourglass
hNoHourglass
When reading the query result, this read operation may be locked and an hourglass appears by default. This constant is used not to display the hourglass in this case. HExecuteQuery, HExecuteSQLQuery
hSaveItemsSaves the values of items in memory when using HSavePosition. These values will be restored next time HRestorePosition is called.HSavePosition
hBoundSeparatorUsed to separate the values of lower and upper bounds for the components of composite keyHFilterIncludedBetween
hSubErrLastType of error returned: Number of the last sub-errorHError
hSubErrPreviousType of error returned: Number of the previous sub-errorHError
hSubErrFirstType of error returned: Number of the first sub-errorHError
hSubErrNextType of error returned: Number of the previous sub-errorHError
hSQLUnicodeUsed to specify that the query text must be sent in Unicode format to the server.
This constant is available in WINDEV Mobile only.
HExecuteSQLQuery
hStructureConfigure the file management: New empty file created from the file descriptionHRegenerateFile
hNoErrorNo error occurredHError
hDeleteLogDeletes the log fileHDeleteFile,
HDeleteDatabase
hBackupCanceledStatus of backup: Backup canceledHInfoBackup
Versions 15 and later
hBackupFull
New in version 15
hBackupFull
hBackupFull
Type of backup: Full backupHInfoBackup
Versions 15 and later
hBackupDifferential
New in version 15
hBackupDifferential
hBackupDifferential
Type of backup: Differential backupHInfoBackup
hBackupInProgressStatus of backup: Backup in progressHInfoBackup
hBackupErrorStatus of backup: Error during backupHInfoBackup
hBackupCompletedStatus of backup: Backup completedHInfoBackup
Versions 15 and later
hBackgroundTask
New in version 15
hBackgroundTask
hBackgroundTask
Execute process in the background, without locking the data file (available for data files in Client/Server mode).HStatCalculate,
HIndex
Versions 19 and later
hWindowsDiskCacheSize
New in version 19
hWindowsDiskCacheSize
hWindowsDiskCacheSize
Mode for managing the size of Windows disk cache.HSetServer
hNdxCacheSizeMaximum size in megabytes (MB) of index cacheHSetServer
hFtxSizeSize of full-text index file in bytes (".Ftx" file)HInfoFile
hFicSizeSize of data file in bytes (".Fic" file)HInfoFile
hMaxLogSizeMaximum size in megabytes (MB) of log filesHSetServer
hMaxActivityStatisticsSizeMaximum size in megabytes (MB) of files for activity statisticsHSetServer
hMmoSizeSize of memo file in bytes (".Mmo" file)HInfoFile
hNdxSizeSize of index file in bytes (".Ndx" file)HInfoFile
hInternetPageSizeSize of page for using the RPC via Internet.Remote access (RPC on HFSQL)
hIntranetPageSizeSize of page for using the RPC via Intranet.Remote access (RPC on HFSQL)
hPageSizeSize of a block of caches. This block of caches will be used when looping through a file. A large block of caches improves the browse and increases the transfers via network and the memory consumption.HSetCache
hTotalSizeTotal file size in bytes (added size of data file, memo file and index file).HInfoFile
Versions 22 and later
hTelemetryEnable
New in version 22
hTelemetryEnable
hTelemetryEnable
Configure the sending of data via the telemetry for the HFSQL server. HSetServer
hYieldFor the UPDATE and DELETE queries performed on an important number of records, this constant is used to give control back to the other applications that use the files.HExecuteQuery, HExecuteSQLQuery
Versions 19 and later
hSecondaryThread
New in version 19
hSecondaryThread
hSecondaryThread
Option for running the procedure: the procedure is run in a secondary thread.HOnServerCall
hActiveSyncFrameThe size of the frame is optimized to be used with Mobile devices.HCS.FrameSize
hDefaultFrameThe standard size will be used by default.HCS.FrameSize
hGPRSFrameThe frame size is optimized for a use via GPRSHCS.FrameSize
hInternetFrameThe frame size is optimized for a use via InternetHCS.FrameSize
hIntranetFrameThe frame size is optimized for a use via IntranetHCS.FrameSize
hWifiFrameThe frame size is optimized for a use via WifiHCS.FrameSize
hTriggerBeforeIndicates the type of trigger: The procedure is run before the HFSQL functionHActivateTrigger, HDeactivateTrigger, HDeleteTrigger, HDescribeTrigger
hTriggerAfterIndicates the type of trigger: The procedure is run after the HFSQL functionHActivateTrigger, HDeactivateTrigger, HDeleteTrigger, HDescribeTrigger
Versions 21 and later
htsNone
New in version 21
htsNone
htsNone
Type ot timestamp for the item: the item is not a timestamp item.TimestampType property
Versions 21 and later
htsCreation
New in version 21
htsCreation
htsCreation
Type ot timestamp for the item: the item will store the creation date of record.TimestampType property
Versions 21 and later
htsLastModification
New in version 21
htsLastModification
htsLastModification
Type ot timestamp for the item: the item will store the date of last modification performed on the record.TimestampType property
hUnicodeUsed to retrieve the record value in Unicode format.HRetrieveRecord, HRecordToString
hDefaultValThe items of destination record that are not affected by the copy are initialized with their default value.
For the non-imported items, the values of current record (HFSQL Classic) are reinitialized with their default value.
HCopyRecord,
HImportHF55,
HImportText,
Versions 20 and later
HImportXLS
New in version 20
HImportXLS
HImportXLS
hMaxValDefines an upper bound for a filterHBuildKeyValue,
HFilter,
HFilterStartsWith,
HFilterIncludedBetween
hMinValDefines a lower bound for a filterHBuildKeyValue,
HFilter,
HFilterStartsWith,
HFilterIncludedBetween
hCheckDuplicatesChecks for duplicates for this operation, even if the duplicate check is disabled (HSetDuplicates)HAdd, HExecuteQuery, HExecuteSQLQuery, HModify
hCheckIntegrityChecks the integrity of operation even if the automatic integrity check is disabled (HSetIntegrity)HAdd, HExecuteQuery, HExecuteSQLQuery, HModify, HCross, HDelete
hCheckMemoStandard reindexing with memo check and correction if necessary (used to retrieve the damaged memos)HIndex
hViewAddCreate a view with addition: Stores the content of the view next time HExecuteView is calledHCreateView, HMergeView
hViewLockingLock records read in the file and included in the viewHCreateView, HMergeView
hViewDefaultDefault creation of viewHCreateView, HMergeView
hViewPostponedThe view is created but it will be run later by HExecuteViewHCreateView, HMergeView
hViewDistinctCreate view without duplicates with respect to the sort keyHCreateView, HMergeView
hViewExclusiveLock the entire source file to reduce the view creation timeHCreateView, HMergeView
hViewBreakableInterrupt view creation by pressing the ESC keyHCreateView
hViewIntersectionMerge views with intersection: Common rows between the two specified viewsHMergeView
hViewJoinJoin between the first view and the second view.HMergeView
hViewSubtractionMerge views with subtraction: Row of the first view without the common rows of the second viewHMergeView
hViewUnionMerging views: Merge the rows of the two specified viewsHMergeView
hViewUnionExExclusive merge of views: Merge the non-common rows of the two specified viewsHMergeView
hWDLThe files are sought:
  1. In the main WDL.
  2. In the WDL according to their load order, then on disk or in the specified WDL, then on disk.
  3. In the main WDL of the component.
  4. In the secondary WDLs of the component according to the load order.
HChangeLocation,
HDeclare
opCancelThis constant must be returned by the procedure or window used to customize the process of HFSQL errors.
The function that triggered the error returns an error and the code continues to run.
HOnError
Versions 27 and later
SP_PBKDF2
New in version 27
SP_PBKDF2
SP_PBKDF2
Key derivation function used to hash an item of type "Password": Password-Based Key Derivation Function 2 (PBKDF2) is used.
Versions 27 and later
spDerivation property
New in version 27
spDerivation property
spDerivation property
Versions 27 and later
SP_SHA2_256
New in version 27
SP_SHA2_256
SP_SHA2_256
Algorithm used for salting an item of type "Password": Secure Hash Algorithm 256 (SHA-256) is used.
Versions 27 and later
spHash property
New in version 27
spHash property
spHash property
Versions 27 and later
SP_SHA2_512
New in version 27
SP_SHA2_512
SP_SHA2_512
Algorithm used for salting an item of type "Password": Secure Hash Algorithm 512 (SHA-512) is used.
Versions 27 and later
spHash property
New in version 27
spHash property
spHash property
Versions 27 and later
SP_SHA3_256
New in version 27
SP_SHA3_256
SP_SHA3_256
Algorithm used for salting an item of type "Password": Secure Hash Algorithm 3-256 (SHA-3 256) is used.
Versions 27 and later
spHash property
New in version 27
spHash property
spHash property
Versions 27 and later
SP_SHA3_512
New in version 27
SP_SHA3_512
SP_SHA3_512
Algorithm used for salting an item of type "Password": Secure Hash Algorithm 3-512 (SHA-3 512) is used.
Versions 27 and later
spHash property
New in version 27
spHash property
spHash property
opEndProgramThis constant must be returned by the procedure or window used to customize the process of HFSQL errors.
The function that triggered the error returns an error and the program stops. Equivalent to the following line of code:
IF NOT <HFSQL function> THEN EndProgram()
HOnError
opEndProcessThis constant must be returned by the procedure or window used to customize the process of HFSQL errors.
The function that triggered the error returns an error and the current process stops. Equivalent to the following line of code:
IF NOT <HFSQL function> THEN SetFocusAndReturnToUserInput()
HOnError
opRetryThis constant must be returned by the procedure or window used to customize the process of HFSQL errors.
In this case, the function that triggered the error is re-run.
HOnError
opRelaunchProgramThis constant must be returned by the procedure or window used to customize the process of HFSQL errors.
The program stops and the application is automatically restarted.
HOnError
Versions 23 and later
The following constants are used to manage HFSQL data files (prefix syntax):
ConstantDescriptionFunctions/Properties
eltSetOfProceduresThe listed element is a set of procedures<Cnt>.ListStoredElement
eltProcedureThe listed element is a stored procedure<Cnt>.ListStoredElement
eltQueryThe listed element is a query.<Cnt>.ListStoredElement
Versions 15 and later
h3G
New in version 15
h3G
h3G
Type of network to simulate: 3G<Cnt>.SimulateNetwork
hAcceptOpenedFileAllows you to read the source file that will be added to the memo if this source file is opened in write mode somewhere else.<Source>.LinkMemo
hAccessHF7Pseudo-connection to HFSQL Classic database.HConnect,
<Source>.DeclareExternal,
HDescribeConnection,
HListFile,
<Cnt>.OpenConnection,
Provider property,
CtOLEDBProvider property,
CtDescribedOLEDBProvider property
hAccessHFClientServerProvider that will be used for the connection: Native Connector to an HFSQL Client/Server databaseHConnect,
<Source>.DeclareExternal,
HDescribeConnection,
HListFile,
<Cnt>.OpenConnection,
Provider property,
CtOLEDBProvider property,
CtDescribedOLEDBProvider property
hAccessJDBCMySQLAccess to a MySQL database via a JDBC driverHDescribeConnection,
<Cnt>.OpenConnection
hAccessJDBCSQLServerAccess to an SQL Server database via a JDBC driverHDescribeConnection,
<Cnt>.OpenConnection
hNativeAccessAS400Provider that will be used for the connection: Native AS/400 Connector (optional module of WINDEV)HConnect,
<Source>.DeclareExternal,
HDescribeConnection,
HListFile,
<Cnt>.OpenConnection,
Provider property,
CtOLEDBProvider property,
CtDescribedOLEDBProvider property
hNativeAccessDB2OLE DB provider that will be used for the connection: Native DB2 Connector (optional module of WINDEV)HConnect,
<Source>.DeclareExternal,
HDescribeConnection,
HListFile,
<Cnt>.OpenConnection,
Provider property,
CtOLEDBProvider property,
CtDescribedOLEDBProvider property
hNativeAccessInformixOLE DB provider that will be used for the connection: Native Informix Connector (optional module of WINDEV)HConnect,
<Source>.DeclareExternal,
HDescribeConnection,
HListFile,
<Cnt>.OpenConnection,
Provider property,
CtOLEDBProvider property,
CtDescribedOLEDBProvider property
Versions 20 and later
hNativeAccessMariaDB
New in version 20
hNativeAccessMariaDB
hNativeAccessMariaDB
OLE DB provider that will be used for the connection: Native MariaDB Connector (optional module of WINDEV/WEBDEV)HConnect,
<Source>.DeclareExternal,
HDescribeConnection,
HListFile,
<Cnt>.OpenConnection,
Provider property,
CtOLEDBProvider property,
CtDescribedOLEDBProvider property
hNativeAccessMySQLOLE DB provider that will be used for the connection: Native MySQL ConnectorHConnect,
<Source>.DeclareExternal,
HDescribeConnection,
HListFile,
<Cnt>.OpenConnection,
Provider property,
CtOLEDBProvider property,
CtDescribedOLEDBProvider property
hNativeAccessOracleOLE DB provider that will be used for the connection: Native Oracle Connector (optional module of WINDEV)HConnect,
<Source>.DeclareExternal,
HDescribeConnection,
HListFile,
<Cnt>.OpenConnection,
Provider property,
CtOLEDBProvider property,
CtDescribedOLEDBProvider property
hNativeAccessOracleLiteProvider that will be used for the connection: Native Oracle Connector (optional module of WINDEV Mobile)HConnect,
<Source>.DeclareExternal,
HDescribeConnection,
HListFile,
<Cnt>.OpenConnection,
Provider property,
CtOLEDBProvider property,
CtDescribedOLEDBProvider property
hNativeAccessPostgreSQLOLE DB provider that will be used for the connection: Native PostgreSQL ConnectorHConnect,
<Source>.DeclareExternal,
HDescribeConnection,
HListFile,
<Cnt>.OpenConnection,
Provider property,
CtOLEDBProvider property,
CtDescribedOLEDBProvider property
hNativeAccessProgressOLE DB provider that will be used for the connection: Native Progress Connector (optional module of WINDEV)HConnect,
<Source>.DeclareExternal,
HDescribeConnection
HListFile,
<Cnt>.OpenConnection,
Provider property,
CtOLEDBProvider property,
CtDescribedOLEDBProvider property
Versions 16 and later
hNativeAccessSQLAzure
New in version 16
hNativeAccessSQLAzure
hNativeAccessSQLAzure
OLE DB provider that will be used for the connection: Native SQL Azure ConnectorHConnect,
<Source>.DeclareExternal,
HDescribeConnection,
HListFile,
<Cnt>.OpenConnection,
Provider property,
CtOLEDBProvider property,
CtDescribedOLEDBProvider property
Versions 15 and later
hNativeAccessSQLite
New in version 15
hNativeAccessSQLite
hNativeAccessSQLite
OLE DB provider that will be used for the connection: Native Connector to an SQLite databaseHConnect,
<Source>.DeclareExternal,
HDescribeConnection,
HListFile,
<Cnt>.OpenConnection,
Provider property,
CtOLEDBProvider property,
CtDescribedOLEDBProvider property
hNativeAccessSQLServerOLE DB provider that will be used for the connection: Native SQL Server Connector (optional module of WINDEV)HConnect,
<Source>.DeclareExternal,
HDescribeConnection,
HListFile,
<Cnt>.OpenConnection,
Provider property,
CtOLEDBProvider property,
CtDescribedOLEDBProvider property
hNativeAccessSQLServerMobileProvider that will be used for the connection: Native SQL Server Mobile Connector (optional module of WINDEV Mobile)HConnect,
<Source>.DeclareExternal,
HDescribeConnection,
HListFile,
<Cnt>.OpenConnection,
Provider property,
CtOLEDBProvider property,
CtDescribedOLEDBProvider property
hNativeAccessSybaseOLE DB provider that will be used for the connection: Native Sybase Connector (optional module of WINDEV)HConnect,
<Source>.DeclareExternal,
HDescribeConnection,
HListFile,
<Cnt>.OpenConnection,
Provider property,
CtOLEDBProvider property,
CtDescribedOLEDBProvider property
hNativeAccessXBaseOLE DB provider that will be used for the connection: Native xBase ConnectorHConnect,
<Source>.DeclareExternal,
HDescribeConnection,
HListFile,
<Cnt>.OpenConnection,
Provider property,
CtOLEDBProvider property,
CtDescribedOLEDBProvider property
hNativeAccessXMLProvider that will be used for the connection: Native XML Connector (included with WINDEV/WEBDEV)HConnect,
<Source>.DeclareExternal,
HDescribeConnection,
HListFile,
<Cnt>.OpenConnection,
Provider property,
CtOLEDBProvider property,
CtDescribedOLEDBProvider property
Versions 23 and later
hActiveDirectory
New in version 23
hActiveDirectory
hActiveDirectory
Enable the authentication via Active Directory. <Cnt>.SetServer
Versions 15 and later
hADSL
New in version 15
hADSL
hADSL
Type of network to simulate: ADSL<Cnt>.SimulateNetwork
hAffectBrowseAddition affecting the current browse<Source>.Add,
<Source>.Modify
hApplicationProperty of a database found on an HFSQL server: Name of the application from which the database was created.HInfoDatabaseProperty,
HInfoFileProperty
hStoppedServer stoppedHServerStatus
Versions 15 and later
hNone
New in version 15
hNone
hNone
Used to disable the simulation of a specific network.<Cnt>.SimulateNetwork
hAllowedThe relevant rights are granted to the user or group.HModifyDatabaseRights,
HModifyFileRights,
HModifyServerRights
hWithFilterIf this parameter is specified:
  • the query result corresponds to a selection of filter records if the HFSQL engine allows it. Otherwise, the query result corresponds to an HFSQL view
  • the following operations are not allowed: search on the query result, query on query, view on query, query on view.
  • the browse items specified when looping through the result are ignored.
  • the magnifier is not available for the tables linked to a query.
  • hNbRec cannot be used on the queries.
If this parameter is not specified (by default):
  • the query result corresponds to an HFSQL view
  • the following operations can be performed on the queries: search on the query result, query on query, view on query, query on view.
  • the browse items specified when looping through the result are taken into account.
  • the magnifier is available on tables linked to a query.
  • hNbRec can be used on the queries.
HExecuteQuery,
HExecuteSQLQuery
hWithTransactionThe query is run in a transaction. A transaction is started, the records are locked in read/write during the execution of the query and they are unlocked at the end of its execution, regardless of the result (failure or success).
If the query cannot end properly (locked records, power failure, etc.), the transaction is canceled and the data files are restored to their previous status (before the query execution).
Remark: The query execution may be slowed down.
HExecuteQuery,
HExecuteSQLQuery
hLockWriteType of lock: Lock in write mode<Source>.Add,
HForward,
HLockFile,
HLockRecNum,
HLast,
HWrite,
HRead,
HReadLast,
HReadPrevious,
HReadFirst,
HReadSeekLast,
HReadSeekFirst,
HReadNext,
<Source>.Modify,
HPrevious,
HFirst,
HCross,
HSeek,
HSeekLast,
HSeekFirst,
HBackward,
HNext
hLockReadWriteType of lock: Lock in read/write<Source>.Add,
HForward,
HLockFile,
HLockRecNum,
HLast,
HWrite,
HRead,
HReadLast,
HReadPrevious,
HReadFirst,
HReadSeekLast,
HReadSeekFirst,
HReadNext,
<Source>.Modify,
HPrevious,
HFirst,
HCross,
HSeek,
HSeekLast,
HSeekFirst,
HBackward,
HNext
hLockNoType of lock: No lock<Source>.Add,
HForward,
HLockFile,
HLockRecNum,
HLast,
HWrite,
HRead,
HReadLast,
HReadPrevious,
HReadFirst,
HReadSeekLast,
HReadSeekFirst,
HReadNext,
<Source>.Modify,
HPrevious,
HFirst,
HCross,
HSeek,
HSeekLast,
HSeekFirst,
HBackward,
HNext
Versions 21 and later
hCacheNbUnusedFiles
New in version 21
hCacheNbUnusedFiles
hCacheNbUnusedFiles
Maximum number of unused HFSQL tables that are stored in cache (which means opened) on the server. <Cnt>.SetServer
Versions 18 and later
hAutoStatisticalCalc
New in version 18
hAutoStatisticalCalc
hAutoStatisticalCalc
Enable the automatic calculation of statistics for the data files (optimization of indexes).<Cnt>.SetServer
hCardinalityIntegrity constraints: Check the link cardinalities.<Cnt>.SetIntegrity
hInfiniteCardinalityMaximum cardinality ("N")MaxLinkedCardinality property,
MaxSourceCardinality property
hChangeCharsetThe character set defined by ChangeCharset will be taken into account in the new data file. Sorts, searches, ... on string keys (strings, characters, date and time) will be performed according to this character set.<Source>.Creation,
<Source>.CreationIfNotFound,
<Source>.Index
hDatabasePathPath of directory containing all databases<Cnt>.SetServer
hJNLPathPath of the directory containing all the logs of the different HFSQL Client/Server applications<Cnt>.SetServer
hJNLBackupPathPath of the directory containing the backups of the logs<Cnt>.SetServer
hLogPathPath of the directory containing the log files<Cnt>.SetServer
hActivityStatisticsPathPath of the directory containing the activity statistics<Cnt>.SetServer
hDuplicateKeyCharacteristics of an item: Key with duplicatesKeyType property
hUniqueKeyCharacteristics of an item: Unique keyKeyType property
Versions 20 and later
hSQLCode
New in version 20
hSQLCode
hSQLCode
Requested information: SQL code of the materialized view
Versions 20 and later
<Cnt>.InfoView
New in version 20
<Cnt>.InfoView
<Cnt>.InfoView
hCompatibleThe structures of the data files (defined in the analysis and found in the physical file) must be compatible.<Source>.CheckStructure
hPackNoCompression mode: No compressionMmoPackMethod property
hPackZLWCompression mode: Compression based on the Ziw-Lempel algorithm, Welch implementation.MmoPackMethod property
hKeepTRSStores the transaction files during the deletion<Cnt>.DeleteDatabase,
<Cnt>.DeleteFile
hCopyAutoIDCopies the automatic identifier while keeping its value<Source>.CopyRecord,
<Source>.ImportHF55,
<Source>.ImportText,
Versions 20 and later
<Source>.ImportXLS
New in version 20
<Source>.ImportXLS
<Source>.ImportXLS
hCopyIndexCopies the index of the data file<Cnt>.CopyFile
hCopyIfNotFoundCopies the data file only if it does not exist at the specified location on the destination computer.<Cnt>.CopyFile
hCorrespondenceGives the correspondence between the numbers of the log functions and the names of the WLanguage functionsHInfoLog
hCreatorProperty of a database found on an HFSQL server: Name of database owner.<Cnt>.InfoDatabaseProperty,
<Cnt>.InfoFileProperty
hCreateIndexThe index of the data file is not copied. It is automatically recreated at the destination by reindexing.<Cnt>.CopyFile
hIncreasingSort performed in ascending orderSortType property
Versions 24 and later
hCryptAES128
New in version 24
hCryptAES128
hCryptAES128
File encryption performed only if a password is defined for the file. In this case, the file is encrypted using a 128-bit AES algorithm with Output feedback (OFB).FicCryptMethod property,
MmoCryptMethod property,
NdxCryptMethod property
Versions 19 and later
hEncryptionAuto
New in version 19
hEncryptionAuto
hEncryptionAuto
File encryption performed only if a password is defined for the file. In this case, the data file is encrypted according to an optimized encryption algorithm (RC5 16 rounds on 128 bits).FicCryptMethod property,
MmoCryptMethod property,
NdxCryptMethod property
hEncryptionNONo file encryption.FicCryptMethod property,
MmoCryptMethod property,
NdxCryptMethod property
hEncryptionRC5_12The file is encrypted according to an optimized encryption algorithm (RC5 12 rounds on 128 bits).FicCryptMethod property,
MmoCryptMethod property,
NdxCryptMethod property
hEncryptionRC5_16The file is encrypted according to an optimized encryption algorithm (RC5 16 rounds on 128 bits).FicCryptMethod property,
MmoCryptMethod property,
NdxCryptMethod property
hEncryptionStandardThe memo file is encrypted according to an optimized encryption algorithm on 128 bits.FicCryptMethod property,
MmoCryptMethod property,
NdxCryptMethod property
hClientCursorCursor managed by MDAC. Offers more features than a server cursor. A client cursor must necessarily be a static cursorHDescribeConnection,
<Cnt>.OpenConnection
hDynamicCursorCursor offering a lot of features but consuming a lot of memory. This cursor allows all types of moves. It allows you to access all the modifications, additions and deletions performed by the other users.HDescribeConnection,
<Cnt>.OpenConnection
hForwardOnlyCursorFast cursor consuming little memory. The move is performed from the first record to the last one. The data modified by the other users is not visible.HDescribeConnection,
<Cnt>.OpenConnection
hReadOnlyCursorThe set of records cannot be modified.HDescribeConnection,
<Cnt>.OpenConnection
hOpenKeysetCursorCursor that handles a fixed set of records. Only the keys corresponding to the record are stored and not the records (consumes less memory). The deleted records can no longer be accessed. Modifications performed by other users are visible (but records added are not).HDescribeConnection,
<Cnt>.OpenConnection
hOptimisticCursorThe record is locked when it is updatedHDescribeConnection,
<Cnt>.OpenConnection
hPessimisticCursorThe record is locked as soon as it goes into edit mode to be modified.HDescribeConnection,
<Cnt>.OpenConnection
hServerCursorCursor managed by the database. This cursor can easily apply the changes performed by the other users to the data.HDescribeConnection,
<Cnt>.OpenConnection
hStaticCursorMakes a copy of all query records in memory (high memory usage). All types of moves are allowed.HDescribeConnection,
<Cnt>.OpenConnection
hDaemonUserUsername that will be used by the server (Linux only)<Cnt>.SetServer
hDateProperty of a database found on an HFSQL server: Creation date of the database.<Cnt>.InfoDatabaseProperty, <Cnt>.InfoFileProperty
Versions 20 and later
hDateLastRefresh
New in version 20
hDateLastRefresh
hDateLastRefresh
Requested information: Date of the last successful refresh for the materialized view.
Versions 20 and later
<Cnt>.InfoView
New in version 20
<Cnt>.InfoView
<Cnt>.InfoView
hDBASCIISort according to ASCII orderHDBSortType
hDisconnectionConfigures the disconnection messageHOnServerCall
hDBLexicographicSort according to the lexicographic orderHDBSortType
hDecreasingSort performed in descending orderSortType property
hDefaultThe rights returned do not take the inherited rights into account (rights granted to the groups to which the user belongs).
If no rights were defined, the value will be set to hInherit.
<Result> contains the values of the requested rights (in the same order).
<Cnt>.InfoDatabaseRights,
<Cnt>.InfoFileRights,
<Cnt>.InfoServerRights
hStartedServer startedHServerStatus
hDetailsThe rights returned do not take the inherited rights into account (rights granted to the groups to which the user belongs).
If no rights were defined, the value will be set to hInherit.
<Result> contains the rights and there value.
<Cnt>.InfoDatabaseRights,
<Cnt>.InfoFileRights,
<Cnt>.InfoServerRights
hDestroyLinkDeletes all links related to the deleted data file.<Cnt>.DeleteFile
hDiskSearch mode for the data files or the analyses: The files are sought on the disk only. This is the most common case<Source>.ChangeLocation,
<Source>.Declare
hDistinctManagement of duplicates during the browse: Only one record is read if duplicates are found when looping through a key item<Source>.Forward,
<Source>.ReadPrevious,
<Source>.ReadNext,
<Source>.Previous,
<Source>.Backward,
<Source>.Next
hDataConfigure the file management: All the operations stored in the log file are applied to the existing file<Cnt>.RegenerateFile
hRightsInsertRights to add new records into a data file.<Cnt>.InfoDatabaseRights,
<Cnt>.InfoFileRights,
<Cnt>.ModifyDatabaseRights,
<Cnt>.ModifyFileRights
hRightsStopServerRights to stop a server (<Connection>.StopServer)<Cnt>.InfoServerRights,
<Cnt>.ModifyServerRights
hRightsLockRights to lock the data files or the records of a data file.<Cnt>.InfoDatabaseRights,
<Cnt>.InfoFileRights,
<Cnt>.ModifyDatabaseRights,
<Cnt>.ModifyFileRights
hRightsChangeRightsRights to change rights.<Cnt>.InfoDatabaseRights,
<Cnt>.InfoFileRights,
<Cnt>.InfoServerRights,
<Cnt>.ModifyDatabaseRights,
<Cnt>.ModifyFileRights,
<Cnt>.ModifyServerRights
hRightsChangeLinkRights to modify the integrity rules on a data file.<Cnt>.InfoDatabaseRights,
<Cnt>.InfoFileRights,
<Cnt>.ModifyDatabaseRights,
<Cnt>.ModifyFileRights
hRightsChangePasswordRights to change the password of a user on the server (the user can change his own password and the administrator can change the password of each user).<Cnt>.InfoServerRights,
<Cnt>.ModifyServerRights
hRightsChangeOwnerRights to modify the owner of an element<Cnt>.InfoDatabaseRights,
<Cnt>.InfoFileRights,
<Cnt>.ModifyDatabaseRights,
<Cnt>.ModifyFileRights
hRightsConnectionRights to connect to a server (encrypted or unencrypted connection)<Cnt>.InfoDatabaseRights,
<Cnt>.ModifyDatabaseRights
hRightsEncryptedConnectionRights to connect to a server (encrypted connection only)<Cnt>.InfoDatabaseRights,
<Cnt>.ModifyDatabaseRights
hRightsCreateDBRights to create a database<Cnt>.InfoServerRights,
<Cnt>.ModifyServerRights
hRightsCreateFileRights to create a data file (with <Source>.Creation)<Cnt>.InfoDatabaseRights,
<Cnt>.ModifyDatabaseRights
Versions 20 and later
hRightsCreateView
New in version 20
hRightsCreateView
hRightsCreateView
Rights to create a SQL view or a materialized view.<Cnt>.InfoDatabaseRights,
<Cnt>.ModifyDatabaseRights
hRightsDebugRights to debug the stored procedures.<Cnt>.InfoDatabaseRights,
<Cnt>.ModifyDatabaseRights
hRightsDisconnectClientRights to disconnect the client computers.<Cnt>.InfoServerRights,
<Cnt>.ModifyServerRights
hRightsSendMessageToClientRights to send messages to the client computers.<Cnt>.InfoServerRights,
<Cnt>.ModifyServerRights
hRightsRunProcedureRights to run the stored procedures.<Cnt>.InfoDatabaseRights,
<Cnt>.ModifyDatabaseRights
hRightsManageDuplicateRights to enable and disable the management of duplicates.<Cnt>.InfoDatabaseRights,
<Cnt>.InfoFileRights,
<Cnt>.ModifyDatabaseRights,
<Cnt>.ModifyFileRights
hRightsManageIntegrityRights to enable and disable the management of integrity.<Cnt>.InfoDatabaseRights,
<Cnt>.ModifyDatabaseRights
hRightsManageTaskRights to manage the scheduled tasks.<Cnt>.InfoServerRights,
<Cnt>.ModifyServerRights
hRightsManageProcedureRights to add, modify and delete the stored procedures.<Cnt>.InfoDatabaseRights,
<Cnt>.ModifyDatabaseRights
hRightsManageServerRights to use <Cnt>.SetServer<Cnt>.InfoServerRights,
<Cnt>.ModifyServerRights
hRightsManageTriggerRights to manage the server triggers (addition, activation, deletion)<Cnt>.InfoDatabaseRights,
<Cnt>.ModifyDatabaseRights
hRightsManageUserRights to delete and add users or groups<Cnt>.InfoServerRights,
<Cnt>.ModifyServerRights
hRightsNoDatabaseAccessRights to prevent access to a database (<Cnt>.NoDatabaseAccess and <Cnt>.EndNoDatabaseAccess)<Cnt>.InfoDatabaseRights,
<Cnt>.ModifyDatabaseRights
hRightsReadRights to read the records of a data file<Cnt>.InfoDatabaseRights,
<Cnt>.InfoFileRights,
<Cnt>.ModifyDatabaseRights,
<Cnt>.ModifyFileRights
hRightsReadLogStatRights to see the activity statistics and the server logs.<Cnt>.InfoServerRights,
<Cnt>.ModifyServerRights
hRightsMaintenanceRights to start a re-index operation or to perform statistical calculations on a data file<Cnt>.InfoDatabaseRights,
<Cnt>.InfoFileRights,
<Cnt>.ModifyDatabaseRights,
<Cnt>.ModifyFileRights
hRightsAutoModifRights to perform the automatic modification of the data files on a file<Cnt>.InfoDatabaseRights,
<Cnt>.InfoFileRights,
<Cnt>.ModifyDatabaseRights,
<Cnt>.ModifyFileRights
hRightsUpdateRights to modify the records of a data file<Cnt>.InfoDatabaseRights,
<Cnt>.InfoFileRights,
<Cnt>.ModifyDatabaseRights,
<Cnt>.ModifyFileRights
hRightsPriorityRights to modify the priority of a client application<Cnt>.InfoServerRights,
<Cnt>.ModifyServerRights
Versions 18 and later
hRightsServerReplication
New in version 18
hRightsServerReplication
hRightsServerReplication
Rights to define and perform a replication between two HFSQL servers.<Cnt>.InfoServerRights,
<Cnt>.ModifyServerRights
hRightsBackupRights to save the data files<Cnt>.InfoDatabaseRights,
<Cnt>.InfoServerRights,
<Cnt>.ModifyDatabaseRights,
<Cnt>.ModifyServerRights
hRightsDeleteRights to delete the records from a data file<Cnt>.InfoDatabaseRights,
<Cnt>.InfoFileRights,
<Cnt>.ModifyDatabaseRights,
<Cnt>.ModifyFileRights
hRightsDeleteDBRights to delete a database<Cnt>.InfoDatabaseRights,
<Cnt>.ModifyDatabaseRights
hRightsDeleteFileRights to delete a data file (<Cnt>.DeleteFile)<Cnt>.InfoDatabaseRights,
<Cnt>.InfoFileRights,
<Cnt>.ModifyDatabaseRights,
<Cnt>.ModifyFileRights
Versions 20 and later
hRightsDeleteView
New in version 20
hRightsDeleteView
hRightsDeleteView
Rights to delete a SQL view or a materialized view.<Cnt>.InfoViewRights, <Cnt>.ModifyViewRights
hRightsAllList of all the rights<Cnt>.InfoDatabaseRights,
<Cnt>.InfoFileRights,
<Cnt>.InfoServerRights
hRightsSeeUserRights to view the characteristics of a group or user.<Cnt>.InfoServerRights,
<Cnt>.ModifyServerRights
hlbDiskAccessValue modifying the coefficient applied to the counter for the number of disk accesses.<Cnt>.SetServer
hlbActiveEnable or disable the load balancing<Cnt>.SetServer
hlbClientCallsValue modifying the coefficient applied to the counter for client calls<Cnt>.SetServer
hlbMaxTimeoutValue modifying the maximum timeout for a server request<Cnt>.SetServer
hlbDiskValue modifying the coefficient applied to the counter for the bytes read or written on disk by the server<Cnt>.SetServer
hlbSentValue modifying the coefficient applied to the counter for the bytes sent by the server<Cnt>.SetServer
hlbReceivedValue modifying the coefficient applied to the counter for the bytes received by the server<Cnt>.SetServer
hWriteDefaultAddition not affecting the current browse/Identifier re-used or calculated for the record<Source>.Add,
<Source>.Write,
<Source>.Modify
hEffectiveThe rights returned correspond to the rights that will be actually granted to the user or to the group on the database. The inherited rights are taken into account (rights granted to the groups to which the user belongs for example).<Cnt>.InfoDatabaseRights,
<Cnt>.InfoFileRights,
<Cnt>.InfoServerRights
hOnUpdateIntegrity rule applied during a modification<Cnt>.SetIntegrity
hRecFileRecord to read: Value of the item currently saved in the data file<Source>.ErrorModification,
<Source>.ErrorStatusModification
hRecReadRecord to read: Value of the item for the source record<Source>.ErrorModification,
<Source>.ErrorStatusModification
hRecUserRecord to read: Value of the item for the current record when performing the modification<Source>.ErrorModification,
<Source>.ErrorStatusModification
hOnDeleteIntegrity rule applied during a deletion<Cnt>.SetIntegrity
hErrDatabaseAccessConfigure the access errors to an HFSQL Client/Server database.<Source>.OnError
hErrADOType of information about the error to return: Error code returned by ADO. The corresponding message is returned by the hErrADOMessage constant.HErrorInfo
hErrBaseType of information about the error to return: Error code returned by the database. The corresponding message is returned by the hErrBaseMessage constantHErrorInfo
hErrLockCustomize lock errors<Source>.OnError
hErrSystemCodeType of information about the error to return: Number of the associated system errorHErrorInfo
hErrFullDetailsType of information about the error to return: Full error details (error line, current process, etc.)
Remark: Returns the same information as the one retrieved via the "Copy" button in the WLanguage error window.
HErrorInfo
hErrDuplicatesCustomize duplicate errors<Source>.OnError
hErrCurrentType of information about the error to return: Number of the current errorHError
Versions 20 and later
hErrorLastRefresh
New in version 20
hErrorLastRefresh
hErrorLastRefresh
Requested information: Last error while refreshing the materialized view.
Versions 20 and later
<Connection>.InfoView
New in version 20
<Connection>.InfoView
<Connection>.InfoView
hErrFICType of information about the error to return: Full name of the data file associated with the errorHErrorInfo
hErrFileType of information about the error to return: Logical name of data file associated with the errorHErrorInfo
hErrLockInfoType of information about the error to return: Information about the lockHErrorInfo
hErrClientInfoInformation about the client layer used by the Native Connector that returned the error.HErrorInfo
hErrDebugInfoType of information about the error to return: Specific information for debugging the problem that occurred. This information should only be displayed and communicated on express demand from PC SOFT.
When running a query via OLE DB, this option allows you to retrieve the code of the SQL query currently run on the database.
HErrorInfo
hErrServerInfoInformation about the server used by the Native Connector that returned the error.HErrorInfo
hErrIntegrityCustomize integrity errors<Source>.OnError
hErrLinkType of information about the error to return: Name of the link associated with the errorHErrorInfo
hErrMessageType of information about the error to return: Message associated with the errorHErrorInfo
hErrADOMessageType of information about the error to return: Message corresponding to the error returned by ADO (hErrADO)HErrorInfo
hErrBaseMessageType of information about the error to return: Message corresponding to the error returned by the database (hErrBase)HErrorInfo
hErrNativeMessageType of information about the error to return: Message corresponding to the error returned by the provider of the Native Connector.HErrorInfo
hErrOLEDBMessageType of information about the error to return: Message corresponding to the error returned by the system during an OLE DB connection (hErrOLEDB)HErrorInfo
hErrSystemMessageType of information about the error to return: Message of associated system errorHErrorInfo
hErrMMOType of information about the error to return: Full name of the memo file associated with the errorHErrorInfo
hErrModifyCustomize a modification conflict<Source>.OnError
hErrPasswordCustomize password errors<Source>.OnError
hErrNativeType of information about the error to return: Error code returned by the Native Connector or the OLE DB provider usedHErrorInfo
hErrNDXType of information about the error to return: Full name of the index file associated with the errorHErrorInfo
hErrRecNumType of information about the error to return: Number of the record associated with the errorHErrorInfo
hErrOLEDBType of information about the error to return: Error code returned by the system during an access via an OLE DB connection.HErrorInfo
hErrConnectionLossCustomize the errors caused by a loss of connection with the server.<Source>.OnError
Versions 20 and later
hErrPositionSQLError
New in version 20
hErrPositionSQLError
hErrPositionSQLError
Type of information about the error to return: Position of the SQL error in the SQL code of the query run by <HFSQL file>.ExecuteSQLQuery.HErrorInfo
hErrMainType of information about the error to return: Number of the main errorHError
hErrIndexCustomize reindexing errors (reindexing in progress when accessing the data file)<Source>.OnError
hErrItemType of information about the error to return: Name of the item associated with the errorHErrorInfo
hErrServerType of information about the error to return: Name of the HFSQL Client/Server server that triggers the errorHErrorInfo
hErrAllCustomize all errors<Source>.OnError
hErrNeedValueCustomize errors caused by a required value that has not been specified (OLE DB only).<Source>.OnError
hErrWDDType of information about the error to return: Full name of the analysis file associated with the errorHErrorInfo
hStateActiveStatus of the record/Type of record taken into account: Active record<Source>.State,
<Source>.NbRec,
<Source>.ErrorStatusModification
hStateInvalidRecord status not found (error)<Source>.State,
<Source>.ErrorStatusModification
hStateCrossedStatus of the record/Type of record taken into account: Crossed record<Source>.State,
<Source>.NbRec,
<Source>.ErrorStatusModification
hStateDelStatus of the record/Type of record taken into account: Deleted record<Source>.State,
<Source>.NbRec,
<Source>.ErrorStatusModification
hStateAllType of record: Total number of records in the data file<Source>.NbRec
hExistingType of search: Only the assignments for which a file actually existsHListREP
hExpCreationMode for creating the export file: The file is overwritten if it already exists.<Source>.ExportXML
Versions 21 and later
<Source>.ExportJSON
New in version 21
<Source>.ExportJSON
<Source>.ExportJSON
Versions 24 and later
<Source>.ExportCSV
New in version 24
<Source>.ExportCSV
<Source>.ExportCSV
Versions 24 and later
<Source>.ExportXLS
New in version 24
<Source>.ExportXLS
<Source>.ExportXLS
hExpBreakableMode for creating the export file: The export can be interrupted by pressing Esc.
If the export is interrupted, the export file is valid and it only contains the records exported before the interruption.
<Source>.ExportXML
Versions 21 and later
<Source>.ExportJSON
New in version 21
<Source>.ExportJSON
<Source>.ExportJSON
Versions 24 and later
<Source>.ExportCSV
New in version 24
<Source>.ExportCSV
<Source>.ExportCSV
Versions 24 and later
<Source>.ExportXLS
New in version 24
<Source>.ExportXLS
<Source>.ExportXLS
hExpNormalMode for creating the export file: Standard operating mode<Source>.ExportXML
Versions 21 and later
<Source>.ExportJSON
New in version 21
<Source>.ExportJSON
<Source>.ExportJSON
Versions 24 and later
<Source>.ExportCSV
New in version 24
<Source>.ExportCSV
<Source>.ExportCSV
Versions 24 and later
<Source>.ExportXLS
New in version 24
<Source>.ExportXLS
<Source>.ExportXLS
Versions 24 and later
hExpNoLineItemName
New in version 24
hExpNoLineItemName
hExpNoLineItemName
Mode for creating the CSV/XLSX file: The first line of the generated file will not contain the names of the items.
Versions 24 and later
<Source>.ExportCSV
New in version 24
<Source>.ExportCSV
<Source>.ExportCSV
Versions 24 and later
<Source>.ExportXLS
New in version 24
<Source>.ExportXLS
<Source>.ExportXLS
hExpWithoutXSLThe style sheet (".XSL" file) is not created<Source>.ExportXML
hFileAS400Type of file: AS400 fileType property
hFileOtherType of file: Other type of fileType property
hFileClientServerType of file: HFSQL Client/Server fileType property
hFileHF5Type of file: Hyper File 5 fileType property
hFileMySQLType of file: MySQL fileType property
hFileNormalType of file: Standard file (HFSQL Classic)Type property
hFileOLEDBType of file: OLEDB fileType property
hFileOracleType of file: ORACLE fileType property
hFileOracleLiteType of file: ORACLE Lite fileType property
Versions 15 and later
hFilePostgreSQL
New in version 15
hFilePostgreSQL
hFilePostgreSQL
Type of file: PostgreSQL fileType property
hFileProgressType of file: Progress fileType property
hFileQueryType of file: QueryType property
hFileQueryAS400Type of file: Query on an AS/400 databaseType property
hFileQueryClientServerType of file: Query on an HFSQL Client/Server databaseType property
hFileQueryMySQLType of file: Query on a MySQL databaseType property
hFileQueryOLEDBType of file: Query on a database accessed via an OLE DB providerType property
hFileQueryOracleType of file: Query on an Oracle databaseType property
hFileQueryOracleLiteType of file: Query on an Oracle Lite databaseType property
Versions 15 and later
hFileQueryPostgreSQL
New in version 15
hFileQueryPostgreSQL
hFileQueryPostgreSQL
Type of file: Query on a PostgreSQL databaseType property
hFileQueryProgressType of file: Query on a Progress databaseType property
Versions 16 and later
hFileQuerySQLAzure
New in version 16
hFileQuerySQLAzure
hFileQuerySQLAzure
Type of file: Query on an SQL Azure databaseType property
hFileQuerySQLServerType of file: Query on an SQL Server databaseType property
hFileQuerySQLServerMobileType of file: Query on an SQL Server Mobile databaseType property
hFileQuerySybaseType of file: Query on a Sybase databaseType property
hFileQueryXMLType of file: Query on an XML databaseType property
hFileSQLType of file: SQL fileType property
Versions 16 and later
hFileSQLAzure
New in version 16
hFileSQLAzure
hFileSQLAzure
Type of file: SQL Azure fileType property
Versions 16 and later
hFileSQLite
New in version 16
hFileSQLite
hFileSQLite
Type of file: SQLite fileType property
hFileSQLServerType of file: SQL Server fileType property
hFileSQLServerMobileType of file: SQL Server Mobile fileType property
hFileSybaseType of file: Sybase fileType property
hFileTemporaryType of file: Temporary fileType property
hFileViewType of file: HFSQL viewType property
hFileXBaseType of file: xBase fileType property
hFileXMLType of file: XML fileType property
hSetIDAutoMode for calculating the automatic identifier: Identifier value equals to the one stored during the addition<Source>.Add,
<Source>.Write,
<Source>.Modify
hSetIDAutoMode for calculating the automatic identifier: Identifier value equals to the one stored during the write operation<Source>.Add,
<Source>.Write,
<Source>.Modify
hANSIFormatData format: Ansi format (used by Windows)Format property
hUNICODEFormatData format: UNICODE formatFormat property
Versions 17 and later
hForwardOnly
New in version 17
hForwardOnly
hForwardOnly
Native Connectors only:
Optimizes simple iterations that do not use the following features:
  • Reading the previous record.
  • Modifying a record.
  • Saving position.
If one of these features is used, the result may differ from the expected one.
For example, this constant can be used when looping through records to populate a Table control programmatically.
<Source>.ReadLast,
<Source>.ReadFirst,
<Source>.ReadSeekFirst,
<Source>.ReadSeekLast
Versions 20 and later
hftPunctuationSimple
New in version 20
hftPunctuationSimple
hftPunctuationSimple
Full-text Index item described programmatically: Taking into account the simple punctuation characters (non Unicode).Option property of variables
of type FullTextIndex Description.
Versions 20 and later
hftPunctuationUnicode
New in version 20
hftPunctuationUnicode
hftPunctuationUnicode
Full-text Index item described programmatically: Taking into account the Unicode punctuation characters.Option property of variables
of type FullTextIndex Description.
hFTXReindexing full-text indexes<Source>.Index
HGenericType of search: Generic search<Source>.ReadSeekLast,
<Source>.ReadSeekFirst,
<Source>.SeekLast,
<Source>.SeekFirst
hHCreationIfNotFoundType of test to run to check the connection: Checks the connection by opening or creating a file (if the file does not exist). This operation can be performed in hOReadWrite mode only.HConnect
hInheritThe user will inherit from the value of the rights granted to the group to which he belongs<Cnt>.ModifyDatabaseRights,
<Cnt>.ModifyFileRights,
<Cnt>.ModifyServerRights
hHOpenType of test to run to check the connection: Checks the connection by opening a file. This value is used by default when accessing to an hORead database.HConnect
hIdenticalThe structures of files (read in the analysis and in the physical file) must be strictly identical.<Source>.ReadSeek,
<Source>.Seek,
<Source>.CheckStructure
hIgnoreDuplicatesDoes not check for duplicates for this action, even if the automatic duplicate check is enabled (<Source>.SetDuplicates)<Source>.Add
hIgnoreIntegrityIgnores the integrity check for this operation, even if the automatic integrity check is enabled (<Cnt>.SetIntegrity)<Source>.Add,
<Source>.Modify,
<Source>.Delete,
<HFSQL file>.Cross
hImpConversionType of import: The associated items do not have the same type or the same size: the data checked out from the imported file is automatically converted or truncated.<Source>.ImportHF55
hImpCreationType of import: If the (HFSQL Classic) import file exists, it is overwritten.<Source>.ImportHF55,
<Source>.ImportText,
Versions 20 and later
<Source>.ImportXLS,
New in version 20
<Source>.ImportXLS,
<Source>.ImportXLS,
<Source>.ImportXML
Versions 21 and later
<Source>.ImportJSON
New in version 21
<Source>.ImportJSON
<Source>.ImportJSON
hImpIgnoreInvalidLineType of import: The lines whose structure are invalid are not imported: the import continues on the following lines. The structure is invalid if data is missing for one or more items, or if string separators are missing.<Source>.ImportText,
Versions 20 and later
<Source>.ImportXLS
New in version 20
<Source>.ImportXLS
<Source>.ImportXLS
Versions 20 and later
hImpIgnoreFirstLine
New in version 20
hImpIgnoreFirstLine
hImpIgnoreFirstLine
Type of import: The first row of the imported file is ignored.<Source>.ImportText,
Versions 20 and later
<Source>.ImportXLS
New in version 20
<Source>.ImportXLS
<Source>.ImportXLS
hImpIgnoreItemType of import:
  • The items found in the import file (HFSQL Classic) without associated items in the imported file (Hyper File 5.5) are filled with their default value.
  • The items of imported file (Hyper File 5.5) with no match in the import file are ignored.
<Source>.ImportHF55
hImpIgnoreEmptyItemIf one or more items are not filled in the text file, the corresponding lines are still imported.
The missing items contain:
  • the default value of items if the hDefaultVal constant is specified.
  • the value of items in the current record before the call to <Source>.ImportText.
<Source>.ImportText,
Versions 20 and later
<Source>.ImportXLS
New in version 20
<Source>.ImportXLS
<Source>.ImportXLS
hImpBreakableThe import can be interrupted by pressing ESC.<Source>.ImportHF55,
<Source>.ImportText,
Versions 20 and later
<Source>.ImportXLS,
New in version 20
<Source>.ImportXLS,
<Source>.ImportXLS,
<Source>.ImportXML
Versions 21 and later
<Source>.ImportJSON
New in version 21
<Source>.ImportJSON
<Source>.ImportJSON
hImpNormalType of import: The import is not performed and an error occurs in the following cases:
  • items found in the Hyper File 5.5 file with no match in the HFSQL Classic file.
  • associated items in the two files but with a different size and/or format.
If the (HFSQL Classic) import file already exists, it is filled with the imported data; otherwise, the file is created.
No management of integrity and no management of duplicates.
The non-imported items take the value of the current record.
The automatic identifiers are recalculated.
<Source>.ImportHF55,
<Source>.ImportText,
Versions 20 and later
<Source>.ImportXLS,
New in version 20
<Source>.ImportXLS,
<Source>.ImportXLS,
<Source>.ImportXML
Versions 21 and later
<Source>.ImportJSON
New in version 21
<Source>.ImportJSON
<Source>.ImportJSON
hImpOEM2ANSIType of import: Convert the imported strings from OEM to ANSI. This constant is available for backward compatibility.<Source>.ImportText
hImpNoDelimiterType of import: The string separators (if they exist) are part of the item<Source>.ImportText
hImpNoSpaceType of import: The space characters found at the end of string are automatically deleted during the import<Source>.ImportHF55
hImpTestDuplicatesType of import: Checks the duplicates during the import<Source>.ImportHF55,
<Source>.ImportText,
Versions 20 and later
<Source>.ImportXLS
New in version 20
<Source>.ImportXLS
<Source>.ImportXLS
hImpTestIntegrityType of import: Checks the integrity during the import<Source>.ImportHF55,
<Source>.ImportText,
Versions 20 and later
<Source>.ImportXLS
New in version 20
<Source>.ImportXLS
<Source>.ImportXLS
hInaccessibleUndefined server statusHServerStatus
Versions 15 and later
hInfoCluster
New in version 15
hInfoCluster
hInfoCluster
Information about the HFSQL cluster.<Cnt>.InfoServer
hInfoDateDate and time of server on 8 bytes in UTC format (universal time)<Cnt>.InfoServer
Versions 22 and later
hInfoFreeDiskSpace
New in version 22
hInfoFreeDiskSpace
hInfoFreeDiskSpace
Available space on the server disk, expressed in MB.<Cnt>.InfoServer
Versions 22 and later
hInfoTotalDiskSpace
New in version 22
hInfoTotalDiskSpace
hInfoTotalDiskSpace
Total capacity of server disk, expressed in MB.<Cnt>.InfoServer
hInfoHardwareInformation about the hardware used:
  • Type of processor (for example: Intel Pentium)
  • Size of server RAM (for example: 630 MB)
This information is returned in the following format:
<Type of CPU> = TAB + <Size of server RAM>
<Cnt>.InfoServer
hInfoNameName of server (DNS)<Cnt>.InfoServer
hInfoLogicalNameName of server given in HFConf.ini or specified during the setup. This name appears in the HFSQL Control Center.<Cnt>.InfoServer
hInfoPlatformInformation about the server platform:
  • Name of operating system: Windows NT 4.0, Windows XP, Windows 2000, Windows 2003, LINUX
  • System version: corresponds to Service Pack in Windows or empty string if no Service Pack is installed. In Linux, corresponds to the version of Linux kernel (2.4.20-8 for example).
This information is returned in the following format:
<System name> + TAB + <Version>
<Cnt>.InfoServer
Versions 19 and later
hInfoSizeCacheNdxUsed
New in version 19
hInfoSizeCacheNdxUsed
hInfoSizeCacheNdxUsed
Size of index cache that is actually used on the server, expressed in MB.<Cnt>.InfoServer
hInfoAllFull information about the server (corresponds to hInfoVi + hInfoVersion + hInfoPlatform + hInfoHardware + hInfoName + hInfoLogicalName + hInfoDate).
The different values are separated by CR characters (Carriage Return).
<Cnt>.InfoServer
hInfoVersionInformation about the version of programs required for the server to operate:
  • Version of Manta.exe or Manta in Linux
  • Version of HFSQL engine (WDHFsrv.dll or WDHFsrv.so in Linux)
  • Version of SQL engine (WDSQLsrv.dll or WDSQLsrv.so in Linux)
This information is returned in the following format:
<Manta version> + TAB + <HFSQL version> +TAB + <SQL version<
<Cnt>.InfoServer
hInfoVersionDetailsDetailed information about the version of the programs required to operate the server:
<Program name> + TAB + <Version number> + TAB + <Internal version number> + TAB + <File date>
The listed elements are as follows:
  • Manta.exe or Manta in Linux
  • HFSQL engine (WDHFsrv.dll or WDHFsrv.so in Linux)
  • SQL engine (WDSQLsrv.dll or WDSQLsrv.so in Linux)
  • Management of logs (HFLogger.exe)
  • MantaManager
  • the framework required to operate the server.
This information is returned in the following format:
<Manta version> + TAB + <HFSQL version> +TAB + <SQL version<
<Cnt>.InfoServer
hInfoVIVersion number of Manta.exe or Manta in Linux<Cnt>.InfoServer
hIntegrityNoneModification/Deletion rule: No integrity managementModificationRule property,
DeletionRule property
hIntegrityCascadeModification/Deletion rule: Cascading modification/deletionModificationRule property,
DeletionRule property
hIntegrityForbiddenModification/Deletion rule: Modification/Deletion not allowedModificationRule property,
DeletionRule property
hIntegrityDefaultValueModification/Deletion rule: Default modification/deletionModificationRule property,
DeletionRule property
hForbiddenThe relevant rights are not granted to the user or group<Cnt>.ModifyDatabaseRights,
<Cnt>.ModifyFileRights,
<Cnt>.ModifyServerRights
hLogJNLFileConfigures the file to recreate: Only <File name>JNL.FIC is recreated.<Source>.LogRecreate
hLogIdentificationConfigures the file to recreate: Re-creates the "JournalIdentification.fic" file.<Source>.LogRecreate
hLogWritingFormat of log process: Log the write operations performed in the fileLogMethod property
hLogReadingWritingFormat of log process: Log the read and write operations performed in the fileLogMethod property
hLogNoFormat of log process: No logLogMethod property
hLogOperationConfigures the file to recreate: Re-creates the "JournalOperation.fic" file.<Source>.LogRecreate
hLogUserConfigures the file to recreate: Recreates the log of users ("UserLog.fic").
This file exists in HFSQL Client/Server only. This file contains the information (login, computer, ...) about the users who perform the logged actions.
<Source>.LogRecreate
Versions 23 and later
hkaInterval
New in version 23
hkaInterval
hkaInterval
Maximum time (in seconds) after which, if no communication is established between the server and the client, the server will check the presence of client. <Cnt>.SetServer
Versions 23 and later
hkaTimeout
New in version 23
hkaTimeout
hkaTimeout
Maximum timeout (in seconds) for the server when checking the presence of client. If the client is not found at the end of this timeout, the client is automatically disconnected. <Cnt>.SetServer
hLanguageCreationUsed to find out whether the language used to perform the comparisons and the sort corresponds to "Defined at creation".Language property,
LanguageDescribed property
Versions 17 and later
hLanguageBinarySort
New in version 17
hLanguageBinarySort
hLanguageBinarySort
The sort will be performed by comparing the binary value of the bytes. This type of sort is very fast. It should be used to perform an exact-match search for example.Language property,
LanguageDescribed property, H.LanguageCreationUnicode
Versions 17 and later
hLanguageFastSort
New in version 17
hLanguageFastSort
hLanguageFastSort
The sort will be performed by comparing the characters one by one according to a generic sort.Language property,
LanguageDescribed property, H.LanguageCreationUnicode
hLimitParsingLimits the file browse: The iteration will stop when the last searched value is found. The current record will correspond to this last record found.
<Source>.Found will be set to False and <Source>.Out will be set to True.
This constant is used to optimize the search speed in client/server mode.
<Source>.ReadSeek, <Source>.ReadSeekLast, <Source>.ReadSeekFirst, <Source>.Seek, <Source>.SeekLast, <Source>.SeekFirst
Versions 22 and later
hlpCalcStat
New in version 22
hlpCalcStat
hlpCalcStat
Type of operation performed on the server: statistical calculation.
Versions 22 and later
hServerOperation type
New in version 22
hServerOperation type
hServerOperation type
Versions 22 and later
hlpKeyDetection
New in version 22
hlpKeyDetection
hlpKeyDetection
Type of operation performed on the server: detection of keys.
Versions 22 and later
hServerOperation type
New in version 22
hServerOperation type
hServerOperation type
Versions 20 and later
hlpOptimization
New in version 20
hlpOptimization
hlpOptimization
Type of scheduling to list: Tasks for optimizing files (re-indexing, statistical calculation).
Versions 22 and later
hlpReplication
New in version 22
hlpReplication
hlpReplication
Type of operation performed on the server: server replication.
Versions 22 and later
hServerOperation type
New in version 22
hServerOperation type
hServerOperation type
Versions 20 and later
hlpBackup
New in version 20
hlpBackup
hlpBackup
Type of scheduling to list: Scheduling of backups.
Versions 20 and later
hlpTask
New in version 20
hlpTask
hlpTask
Type of scheduling to list: Scheduled tasks that run a stored procedure.
Versions 20 and later
hlpMaterializedView
New in version 20
hlpMaterializedView
hlpMaterializedView
Type of scheduling to list: Tasks for refreshing the materialized views.
hLstKeyLists the key items<Source>.ListKey,
<Source>.ListItem
hLstCompositeKeyLists the composite key items only<Source>.ListKey,
<Source>.ListItem
hLstSetLists the sets of procedures found on a server<Cnt>.ListStoredElement
hLstDetailLists the detailed information<Source>.ListKey,
HListFile,
<Source>.ListLink,
<Source>.ListItem,
HListConnection,
<Cnt>.ListStoredElement
hLstDetailPlusFor the numeric items or keys, adds to the detailed information the number of digits found in the integer part and in the decimal part.<Source>.ListKey,
<Source>.ListItem
hLstFileLists the databases and their files for the server defined by the connection<Cnt>.ListDatabase
hLstMemoLists the memo items<Source>.ListItem
hLstNormalLists all keys/List not sorted, not detailed, without the files described dynamically/List of links/Lists the items (except for composite key items)/List of connections, not sorted, not detailed, without the connections described dynamically.<Source>.ListKey,
HListFile,
<Source>.ListItem,
HListConnection
hLstLogicalOrderLists the items or the keys according to the logical order of items<Source>.ListKey,
<Source>.ListItem
hLstOpenedStores the opened connections onlyHListConnection
hLstStoredProcedureLists the stored procedures of a connection via Native Connectors or OLE DBHListFile,
<Cnt>.ListStoredElement
hLstQuery
  • Lists the queries found on a server
  • Versions 19 and later
    Lists the queries that have been run.
    New in version 19
    Lists the queries that have been run.
    Lists the queries that have been run.
hLstItemLists the non-key and non-memo items<Source>.ListItem
hLstOriginalItemUsed on a log file (xxxJNL.fic), lists the items of the source file (that was logged). For example, on CustomerLOG.Fic, lists the items of CUSTOMER file.<Source>.ListKey, <Source>.ListItem
hLstTableList of user tables for a connection via Native Connectors or OLE DBHListFile
hLstSystemTableList of system tables for a connection via Native Connectors or OLE DBHListFile
Versions 22 and later
hLstDatabaseSize
New in version 22
hLstDatabaseSize
hLstDatabaseSize
List of connection databases as well as their size. <Cnt>.ListDatabase
hLstAllLists all the keys, all the files, all the items or all the connections<Source>.ListKey,
HListFile,
<Source>.ListItem,
HListConnection,
<Cnt>.ListStoredElement
hLstSortedSorts the list of keys, files, items or connection in ascending order<Source>.ListKey,
HListFile,
<Source>.ListItem,
HListConnection
hLstView
  • List the views of a connection via Native Connectors or OLE DB.
  • Versions 20 and later
    List the SQL views on an HFSQL server.
    New in version 20
    List the SQL views on an HFSQL server.
    List the SQL views on an HFSQL server.
HListFile
Versions 20 and later
hLstMaterializedView
New in version 20
hLstMaterializedView
hLstMaterializedView
Lists the materialized views found on an HFSQL server.HListFile
hComputerProperty of a database found on an HFSQL server: Name of the computer from which the element was created.<Cnt>.InfoDatabaseProperty,
<Cnt>.InfoFileProperty
hMemoAutoThe memos are read during the access to the item<Source>.SetMemo
hMemoBinType of file used for the memo: Any binary file<Source>.LinkMemo
hMemoImgType of file used for the memo: Image file<Source>.LinkMemo
hMemoNoNo management of memos<Source>.SetMemo
hMemoOleType of file used for the memo: OLE file<Source>.LinkMemo
hMemoYesThe text memos are read whenever the record is read.
Read the binary memos when accessing the item.
<Source>.SetMemo
hMemoWavType of file used for the memo: sound file<Source>.LinkMemo
hMessageConfigures the information messageHOnServerCall
hMode2GBIndicates whether system files support more than 2 GB<Cnt>.SetServer
Versions 20 and later
hMmoCompact
New in version 20
hMmoCompact
hMmoCompact
Compression and defragmentation of "Mmo" files.<Source>.Index
hModeDirectPriority implementation of locks<Source>.Mode
hModeMonoSingle-user lock mode<Source>.Mode
hModeMultiMulti-user lock mode<Source>.Mode
hModeReservationNon-priority implementation of locks<Source>.Mode
hModifyFileWhen modifying the query result, these modifications will be applied to the files belonging to the query.
If this option is not specified, only the query result is modified.
<HFSQL file>.ExecuteQuery,
<HFSQL file>.ExecuteSQLQuery
Versions 17 and later
hmsNormal
New in version 17
hmsNormal
hmsNormal
Standard operating mode of the automatic data modification.
Versions 17 and later
<Source>.ModifyStructure
New in version 17
<Source>.ModifyStructure
<Source>.ModifyStructure
Versions 17 and later
hmsNoCheck
New in version 17
hmsNoCheck
hmsNoCheck
The automatic data modification is performed even if the file description is more recent than the analysis description.
Versions 17 and later
<Source>.ModifyStructure
New in version 17
<Source>.ModifyStructure
<Source>.ModifyStructure
Versions 17 and later
hmsBackgroundTask
New in version 17
hmsBackgroundTask
hmsBackgroundTask
A hot automatic modification is performed (available for the HFSQL Client/Server data files only).
Versions 17 and later
<Source>.ModifyStructure
New in version 17
<Source>.ModifyStructure
<Source>.ModifyStructure
hNdxCompactReindexing with compression<Source>.Index
hNdxMinimalReindex and ignore corrupted keys<Source>.Index
hNdxSilentConfigure reindexing: No display during reindexing<Source>.Index
hNdxNormalStandard reindexing<Source>.Index
hNdxNoStatReindex without calculating statistics<Source>.Index
hNdxDeleteReindex and delete damaged records<Source>.Index
hLogLevelDefines the elements that must be in the log file<Cnt>.SetServer
Versions 24 and later
hMaxNumberConnection
New in version 24
hMaxNumberConnection
hMaxNumberConnection
Maximum number of connections allowed per application. <Cnt>.SetServer
hNonBlockingNumber of records retrieved in the view or query without waiting for the view or query to be entirely filled. To knwo if the execution of the view or query is completed, use the ExecutionCompleted property property.
This constant is available for the views and queries in HFSQL Classic or Client/Server.
This constant has no effect for the data files and for the Native Connectors
<Source>.NbRec
hNotAKeyCharacteristics of an item: Non-key itemKeyType property
hNotReplicatedReplication mode: The data file is not configured for replication. To implement the replication, check "Replication" in the characteristics of the file in the data model editor.Replication property
hNotSortedSort direction: Item not sortedSortType property
hNotesProperty of a database found on an HFSQL server: Database description or any other information associated with the database by <Cnt>.ModifyDatabaseProperty.<Cnt>.InfoDatabaseProperty, <Cnt>.InfoFileProperty, <Cnt>.InfoServerProperty, <Cnt>.ModifyDatabaseProperty, <Cnt>.ModifyFileProperty, <Cnt>.ModifyServerProperty
Versions 18 and later
hNotifWarning
New in version 18
hNotifWarning
hNotifWarning
The notifications will be sent from the warning level (for the warning, critical and error problems).<Cnt>.NotifAddCCRecipient, <Cnt>.NotifAddEmailRecipient
Versions 18 and later
hNotifCCClassic
New in version 18
hNotifCCClassic
hNotifCCClassic
The notifications are sent by the Control Centers in HFSQL Classic mode.
Versions 18 and later
<Cnt>.NotifConfigure
New in version 18
<Cnt>.NotifConfigure
<Cnt>.NotifConfigure
Versions 18 and later
hNotifCCCS
New in version 18
hNotifCCCS
hNotifCCCS
The notifications are sent by the Control Centers in Client/Server mode.
Versions 18 and later
<Cnt>.NotifConfigure
New in version 18
<Cnt>.NotifConfigure
<Cnt>.NotifConfigure
Versions 18 and later
hNotifCritical
New in version 18
hNotifCritical
hNotifCritical
The notifications will be sent from the critical level (for the critical and error problems).<Cnt>.NotifAddCCRecipient, <Cnt>.NotifAddEmailRecipient
Versions 18 and later
hNotifEmail
New in version 18
hNotifEmail
hNotifEmail
The notifications are sent by email.
Versions 18 and later
<Cnt>.NotifConfigure
New in version 18
<Cnt>.NotifConfigure
<Cnt>.NotifConfigure
Versions 18 and later
hNotifError
New in version 18
hNotifError
hNotifError
The notifications will be sent for the error problems only.<Cnt>.NotifAddCCRecipient, <Cnt>.NotifAddEmailRecipient
Versions 22 and later
hNotifInformation
New in version 22
hNotifInformation
hNotifInformation
The notifications will be sent from the information level (for the information, warning, critical and error problems)<Cnt>.NotifAddCCRecipient, <Cnt>.NotifAddEmailRecipient
hCurrentRecNumNumber of the current record.HFSQL functions
hInvalidRecNumConstant returned if there is no current record or if the specified file corresponds to a multi-file query.<Source>.RecNum
Versions 22 and later
hRecNumAll
New in version 22
hRecNumAll
hRecNumAll
  • Used to track all records found in a data file.
  • Versions 23 and later
    Used to check all unaltered records
    New in version 23
    Used to check all unaltered records
    Used to check all unaltered records
hODBCOLE DB provider that will be used for the connection: OLE DB provider for ODBC. Allows you to access an ODBC source declared in the ODBC data sources of WindowsCtOLEDBProvider property,
CtDescribedOLEDBProvider property,
HConnect,
<Source>.DeclareExternal,
HListFile,
<Cnt>.OpenConnection,
SQLConnect
hOReadFile accessible in read-onlyCtAccess property,
CtDescribedAccess property,
HConnect,
<Source>.Open
hOReadWriteFile accessible in read/writeCtAccess property,
CtDescribedAccess property,
HConnect, <Source>.Open
hOledbAccess97OLE DB provider that will be used for the connection: OLE DB provider for Access 97CtOLEDBProvider property,
CtDescribedOLEDBProvider property,
HConnect, <Source>.DeclareExternal, HListFile, <Cnt>.OpenConnection, SQLConnect
hOledbAccess2000OLE DB provider that will be used for the connection: OLE DB provider for Access 2000CtOLEDBProvider property,
CtDescribedOLEDBProvider property,
HConnect, <Source>.DeclareExternal, HListFile, <Cnt>.OpenConnection, SQLConnect
hOledbAccess2007OLE DB provider that will be used for the connection: OLE DB provider for Access 2007CtOLEDBProvider property,
CtDescribedOLEDBProvider property,
HConnect, <Source>.DeclareExternal, HListFile, <Cnt>.OpenConnection, SQLConnect
Versions 19 and later
hOledbAccess2010
New in version 19
hOledbAccess2010
hOledbAccess2010
OLE DB provider that will be used for the connection: OLE DB provider for Access 2010CtOLEDBProvider property,
CtDescribedOLEDBProvider property,
HConnect, <Source>.DeclareExternal, HListFile, <Cnt>.OpenConnection, SQLConnect
hOledbDBase5OLE DB provider that will be used for the connection: OLE DB provider for dBase 5CtOLEDBProvider property,
CtDescribedOLEDBProvider property,
HConnect, <Source>.DeclareExternal, HListFile, <Cnt>.OpenConnection, SQLConnect
hOledbExcel2000OLE DB provider that will be used for the connection: OLE DB provider for Excel 2000CtOLEDBProvider property,
CtDescribedOLEDBProvider property,
HConnect, <Source>.DeclareExternal, HListFile, <Cnt>.OpenConnection, SQLConnect
hOledbExcel2007OLE DB provider that will be used for the connection: OLE DB provider for Excel 2007CtOLEDBProvider property,
CtDescribedOLEDBProvider property,
HConnect, <Source>.DeclareExternal, HListFile, <Cnt>.OpenConnection, SQLConnect
hOledbExcel97OLE DB provider that will be used for the connection: OLE DB provider for Excel 97CtOLEDBProvider property,
CtDescribedOLEDBProvider property,
HConnect, <Source>.DeclareExternal, HListFile, <Cnt>.OpenConnection, SQLConnect
hOledbLotus4OLE DB provider that will be used for the connection: OLE DB provider for Lotus 4CtOLEDBProvider property,
CtDescribedOLEDBProvider property,
HConnect, <Source>.DeclareExternal, HListFile, <Cnt>.OpenConnection, SQLConnect
hOledbOracleOLE DB provider that will be used for the connection: OLE DB provider for OracleCtOLEDBProvider property,
CtDescribedOLEDBProvider property,
HConnect, <Source>.DeclareExternal, HListFile, <Cnt>.OpenConnection, SQLConnect
hOledbSQLServerOLE DB provider that will be used for the connection: OLE DB provider for SQL ServerCtOLEDBProvider property,
CtDescribedOLEDBProvider property,
HConnect, <Source>.DeclareExternal, HListFile, <Cnt>.OpenConnection, SQLConnect
Versions 15 and later
hOptIndex
New in version 15
hOptIndex
hOptIndex
Optimization options: Provokes the re-indexing operation on the data files. A hot re-indexing operation is performed on the indexes and on the full-text indexes.hFileParameter variable
Versions 15 and later
hOptStat
New in version 15
hOptStat
hOptStat
Optimization options: Provokes the recalculation of statistics on the data files.hFileParameter variable
hDelayedOpeningOptimize the opening of existing files: If the file already exists, it will be opened during the first access to the file. The file is created if it does not exist.<Source>.CreationIfNotFound
hActivityStatisticsPeriodIndicates the period (in second) between each backup of values for the different activity counters.<Cnt>.SetServer
hDebuggingPortPort used to debug the stored procedures and the server triggers.<Cnt>.SetServer
hServerPortNetwork port used<Cnt>.SetServer
hPrecisionHighPosition with high precision<Source>.GetCurrentPosition, <Source>.SetPosition
hPrecisionLowPosition with low precision<Source>.GetCurrentPosition, <Source>.SetPosition
hPrecisionMediumPosition with medium precision<Source>.GetCurrentPosition, <Source>.SetPosition
hOwnerProperty of a database found on an HFSQL server: Owner of database.<Cnt>.InfoDatabaseProperty, <Cnt>.InfoFileProperty, <Cnt>.ModifyDatabaseProperty, <Cnt>.ModifyFileProperty
Versions 20 and later
hRefreshInProgress
New in version 20
hRefreshInProgress
hRefreshInProgress
Requested information: Is the materialized view currently refreshed?
Versions 20 and later
<Cnt>.InfoView
New in version 20
<Cnt>.InfoView
<Cnt>.InfoView
Versions 19 and later
hReadCommitted
New in version 19
hReadCommitted
hReadCommitted
Isolation level of transaction: other users can only view completed transactions.
Versions 19 and later
<Cnt>.TransactionIsolation
<Cnt>.TransactionIsolation
Versions 19 and later
hReadUncommitted
New in version 19
hReadUncommitted
hReadUncommitted
Isolation level of transaction: other users can view incomplete transactions.
Versions 19 and later
<Cnt>.TransactionIsolation
<Cnt>.TransactionIsolation
hRecalculateIDAutoMode for calculating the automatic identifier: Automatic identifier re-calculated during the write operation<Source>.Write,
<Source>.Modify
Versions 22 and later
hFindKey
New in version 22
hFindKey
hFindKey
Enable the search for keys on the HFSQL server. <Cnt>.SetServer
Versions 19 and later
hRepeatableRead
New in version 19
hRepeatableRead
hRepeatableRead
Isolation level of transaction: the application in transaction sees a snapshot of the database when the transaction starts.
Versions 19 and later
<Cnt>.TransactionIsolation
<Cnt>.TransactionIsolation
hSubscriberReplicaReplication mode: The data file is a subscriber replica (HCreateSubscriberReplica was used to create the subscriber replica)Replication property
hMasterReplicaReplication mode: The data file is a master replica (HCreateMasterReplica was used to create the master replica)Replication property
hReplicatedReplication mode: The data file is configured to be replicated.Replication property
hQueryDefaultThe query is initialized without interruption<HFSQL file>.ExecuteQuery, <HFSQL file>.ExecuteSQLQuery
hQueryBreakableThe query initialization can be interrupted with the ESC key<HFSQL file>.ExecuteQuery, <HFSQL file>.ExecuteSQLQuery
hQueryWithoutCorrectionNative Connector or OLE DB only:
No check is performed by the HFSQL engine. This option must be used if the query contains commands specific to a connection type (Oracle, SQL Server, etc.)
<HFSQL file>.ExecuteQuery, <HFSQL file>.ExecuteSQLQuery
hQueryWithoutHFCorrectionHFSQL only
The file format (filled with space characters or not) is not checked by the HFSQL engine. To be used if the query handles both HFSQL files in a format that fills items with space characters and HFSQL files in a format that does not fill items with space characters.
<HFSQL file>.ExecuteQuery, <HFSQL file>.ExecuteSQLQuery
Versions 17 and later
hTempDirectory
New in version 17
hTempDirectory
hTempDirectory
Path of temporary directory. This directory is used to create the temporary files if necessary (temporary files created when re-indexing large data files for example).<Cnt>.SetServer
hKeepFilterThe filter set by HFilter will be taken into account, even if the search key is not optimized for the filter.
Reminder: HFilter returns the search key optimized for the filter.
Caution: in this case, performance problems may occur on large files.
<Source>.ChangeKey,
<Source>.Last,
<Source>.ReadLast,
<Source>.ReadFirst,
<Source>.ReadSeekLast,
<Source>.ReadSeekFirst,
<Source>.ReadSeek,
HFirst,
<Source>.Seek,
<Source>.SeekLast,
<Source>.SeekFirst
hRPKeepConfigure the restore operation: Position not freed<Source>.RestorePosition
hRPDefaultConfigure the restore operation: Position freed. The stored position is restored<Source>.RestorePosition
hRPFilterConfigure the restore operation: Restore the filter set when <HFSQL file>.SavePosition is called<Source>.RestorePosition
hRPHF5Configure the restore operation: If the stored position was deleted or modified, this position is restored<Source>.RestorePosition
Versions 22 and later
hrsCopy
New in version 22
hrsCopy
hrsCopy
Configure the replication between servers: Enables the initial copy of replicated elements from the connection server (master server) to the other server (subscriber server, defined in the hRSConfig variable). This copy is locking. <Cnt>.RSAddConfig
Versions 22 and later
hrsCopyBackgroundTask
New in version 22
hrsCopyBackgroundTask
hrsCopyBackgroundTask
Configure the replication between servers: Enables the initial copy of replicated elements from the connection server (master server) to the other server (subscriber server, defined in the hRSConfig variable). This copy is performed in background task and it is not locking. <Cnt>.RSAddConfig
Versions 22 and later
hrsNoCopy
New in version 22
hrsNoCopy
hrsNoCopy
Configure the replication between servers: No copy is performed.<Cnt>.RSAddConfig
hItemBinaryItem type: BinaryType property
hItemBooleanItem type: BooleanType property
hItemCharacterItem type: CharacterType property
Versions 20 and later
hItemCombination
New in version 20
hItemCombination
hItemCombination
Item type: CombinationType property
hItemDate6Item type: DateType property
hItemDate8Item type: DateType property
hItemDateTimeItem type: Date/TimeType property
hItemTimeLengthItem type: DurationType property
hItemInteger1Item type: 1-byte integerType property
hItemInteger2Item type: 2-byte integerType property
hItemInteger4Item type: 4-byte integerType property
hItemInteger8Item type: 8-byte integerType property
hItemUnsignedInteger1Item type: Unsigned 1-byte integerType property
hItemUnsignedInteger2Item type: Unsigned 2-byte integerType property
hItemUnsignedInteger4Item type: Unsigned 4-byte integerType property
hItemUnsignedInteger8Item type: Unsigned 4-byte integerType property
Versions 20 and later
hItemEnumeration
New in version 20
hItemEnumeration
hItemEnumeration
Item type: EnumerationType property
hItemHourItem type: TimeType property
hItemIDAutoItem type: Automatic identifier (8 bytes)Type property
hItemIDAuto4Item type: Automatic identifier (4 bytes)Type property
hItemPictureItem type: ImageType property
hItemInvalidInvalid type of itemType property
Versions 24 and later
hItemJSON
New in version 24
hItemJSON
hItemJSON
Item type: JSONType property
hItemBinaryMemoItem type: Binary MemoType property
hItemBinaryMemo4Item type: Binary memo (4 bytes)Type property
hItemTextMemoItem type: Text MemoType property
hItemUnicodeMemoItem type: Unicode Text MemoType property
hItemCurrencyItem type: CurrencyType property
Versions 27 and later
hItemSecurePassword
New in version 27
hItemSecurePassword
hItemSecurePassword
Item type: PasswordType property
hItemNumRecItem type: Record numberType property
hItemNumericItem type: High-precision numericType property
hItemReal4Item type: 4-byte realType property
hItemReal8Item type: 8-byte realType property
hItemRealTurboItem type: Turbo realType property
hItemTextItem type: TextType property
hItemUnicodeTextItem type: Unicode textType property
Versions 24 and later
hItemUUID128
New in version 24
hItemUUID128
hItemUUID128
Item type: UUID 128Type property
Versions 24 and later
hItemUUID128Auto
New in version 24
hItemUUID128Auto
hItemUUID128Auto
Item type: UUID 128 automatic identifierType property
Versions 24 and later
hItemUUID256
New in version 24
hItemUUID256
hItemUUID256
Item type: UUID 256Type property
Versions 24 and later
hItemUUID256Auto
New in version 24
hItemUUID256Auto
hItemUUID256Auto
Item type: UUID 256 automatic identifierType property
Versions 22 and later
hsAdd
New in version 22
hsAdd
hsAdd
Monitors the operations for adding records.
Versions 22 and later
<Source>.Track
New in version 22
<Source>.Track
<Source>.Track
Versions 22 and later
hsModification
New in version 22
hsModification
hsModification
Monitors the operations for modifying records.
Versions 22 and later
<Source>.Track
New in version 22
<Source>.Track
<Source>.Track
Versions 22 and later
hsCross
New in version 22
hsCross
hsCross
Monitors the operations for crossing records.
Versions 22 and later
<Source>.Track
New in version 22
<Source>.Track
<Source>.Track
Versions 22 and later
hsDeletion
New in version 22
hsDeletion
hsDeletion
Monitors the operations for deleting records.
Versions 22 and later
<Source>.Track
New in version 22
<Source>.Track
<Source>.Track
Versions 20 and later
NoWait
New in version 20
NoWait
NoWait
The refresh of materialized view is not a locking operation: it is performed in background task. <Connection>.InfoView returns the information of the materialized view after being refreshed.
Versions 20 and later
<Cnt>.RefreshView
New in version 20
<Cnt>.RefreshView
<Cnt>.RefreshView
hNoBindRun a query without enabling the bind<HFSQL file>.ExecuteQuery, <HFSQL file>.ExecuteSQLQuery,
<Source>.PrepareSQLQuery
hNoCheckNo check is performed, the analysis description may differ from the description of physical file.<Source>.CheckStructure
hNoIndexThe file index is not copied<Cnt>.CopyFile
hNoLinkManagement of integrity: The links are not updated on the server (creation, modification or deletion).
Reminder: by default, the links are updated on the server when creating a file.
<Source>.Creation, <Source>.CreationIfNotFound
hNoRefreshThe table or query content will not be refreshed<Source>.Last,
<Source>.ReadLast,
<Source>.ReadFirst,
<Source>.First
Versions 21 and later
hNoHourglass
New in version 21
hNoHourglass
hNoHourglass
When reading the query result, this read operation may be locked and an hourglass appears by default. This constant is used not to display the hourglass in this case. <HFSQL file>.ExecuteQuery, <HFSQL file>.ExecuteSQLQuery
hSaveItemsSaves the values of items in memory when using HSavePosition. These values will be restored next time <Source>.RestorePosition is called.<HFSQL file>.SavePosition
hBoundSeparatorUsed to separate the values of lower and upper bounds for the components of composite key<Source>.FilterIncludedBetween
hSubErrLastType of error returned: Number of the last sub-errorHError
hSubErrPreviousType of error returned: Number of the previous sub-errorHError
hSubErrFirstType of error returned: Number of the first sub-errorHError
hSubErrNextType of error returned: Number of the previous sub-errorHError
hSQLUnicodeUsed to specify that the query text must be sent in Unicode format to the server.
This constant is available in WINDEV Mobile only.
<HFSQL file>.ExecuteSQLQuery
hStructureConfigure the file management: New empty file created from the file description<Cnt>.RegenerateFile
hNoErrorNo error occurredHError
hDeleteLogDeletes the log file<Cnt>.DeleteFile,
<Cnt>.DeleteDatabase
hBackupCanceledStatus of backup: Backup canceled<Cnt>.InfoBackup
Versions 15 and later
hBackupFull
New in version 15
hBackupFull
hBackupFull
Type of backup: Full backup<Cnt>.InfoBackup
Versions 15 and later
hBackupDifferential
New in version 15
hBackupDifferential
hBackupDifferential
Type of backup: Differential backup<Cnt>.InfoBackup
hBackupInProgressStatus of backup: Backup in progress<Cnt>.InfoBackup
hBackupErrorStatus of backup: Error during backup<Cnt>.InfoBackup
hBackupCompletedStatus of backup: Backup completed<Cnt>.InfoBackup
Versions 15 and later
hBackgroundTask
New in version 15
hBackgroundTask
hBackgroundTask
Execute process in the background, without locking the data file (available for data files in Client/Server mode).<Source>.StatCalculate,
<Source>.Index
Versions 19 and later
hWindowsDiskCacheSize
New in version 19
hWindowsDiskCacheSize
hWindowsDiskCacheSize
Mode for managing the size of Windows disk cache.<Cnt>.SetServer
hNdxCacheSizeMaximum size in megabytes (MB) of index cache<Cnt>.SetServer
hFtxSizeSize of full-text index file in bytes (".Ftx" file)<Source>.InfoFile
hFicSizeSize of data file in bytes (".Fic" file)<Source>.InfoFile
hMaxLogSizeMaximum size in megabytes (MB) of log files<Cnt>.SetServer
hMaxActivityStatisticsSizeMaximum size in megabytes (MB) of files for activity statistics<Cnt>.SetServer
hMmoSizeSize of memo file in bytes (".Mmo" file)<Source>.InfoFile
hNdxSizeSize of index file in bytes (".Ndx" file)<Source>.InfoFile
hInternetPageSizeSize of page for using the RPC via Internet.Remote access (RPC on HFSQL)
hIntranetPageSizeSize of page for using the RPC via Intranet.Remote access (RPC on HFSQL)
hPageSizeSize of a block of caches. This block of caches will be used when looping through a file. A large block of caches improves the browse and increases the transfers via network and the memory consumption.HSetCache
hTotalSizeTotal file size in bytes (added size of data file, memo file and index file).<Source>.InfoFile
Versions 22 and later
hTelemetryEnable
New in version 22
hTelemetryEnable
hTelemetryEnable
Configure the sending of data via the telemetry for the HFSQL server. <Cnt>.SetServer
hYieldFor the UPDATE and DELETE queries performed on an important number of records, this constant is used to give control back to the other applications that use the files.<HFSQL file>.ExecuteQuery, <HFSQL file>.ExecuteSQLQuery
Versions 19 and later
hSecondaryThread
New in version 19
hSecondaryThread
hSecondaryThread
Option for running the procedure: the procedure is run in a secondary thread.HOnServerCall
hActiveSyncFrameThe size of the frame is optimized to be used with Mobile devices.HCS.FrameSize
hDefaultFrameThe standard size will be used by default.HCS.FrameSize
hGPRSFrameThe frame size is optimized for a use via GPRSHCS.FrameSize
hInternetFrameThe frame size is optimized for a use via InternetHCS.FrameSize
hIntranetFrameThe frame size is optimized for a use via IntranetHCS.FrameSize
hWifiFrameThe frame size is optimized for a use via WifiHCS.FrameSize
hTriggerBeforeIndicates the type of trigger: The procedure is run before the HFSQL functionHActivateTrigger,
HDeactivateTrigger,
<Source>.DeleteTrigger,
<Source>.DescribeTrigger
hTriggerAfterIndicates the type of trigger: The procedure is run after the HFSQL functionHActivateTrigger,
HDeactivateTrigger,
<Source>.DeleteTrigger,
<Source>.DescribeTrigger
Versions 21 and later
htsNone
New in version 21
htsNone
htsNone
Type ot timestamp for the item: the item is not a timestamp item.TimestampType property
Versions 21 and later
htsCreation
New in version 21
htsCreation
htsCreation
Type ot timestamp for the item: the item will store the creation date of record.TimestampType property
Versions 21 and later
htsLastModification
New in version 21
htsLastModification
htsLastModification
Type ot timestamp for the item: the item will store the date of last modification performed on the record.TimestampType property
hUnicodeUsed to retrieve the record value in Unicode format.<Source>.RetrieveRecord
hDefaultValThe items of destination record that are not affected by the copy are initialized with their default value.
For the non-imported items, the values of current record (HFSQL Classic) are reinitialized with their default value.
<Source>.CopyRecord,
<Source>.ImportHF55,
<Source>.ImportText,
Versions 20 and later
<Source>.ImportXLS
New in version 20
<Source>.ImportXLS
<Source>.ImportXLS
hMaxValDefines an upper bound for a filter<Source>.BuildKeyValue,
<Source>.Filter,
<Source>.FilterStartsWith,
<Source>.FilterIncludedBetween
hMinValDefines a lower bound for a filter<Source>.BuildKeyValue,
<Source>.Filter,
<Source>.FilterStartsWith,
<Source>.FilterIncludedBetween
hCheckDuplicatesChecks for duplicates for this operation, even if the duplicate check is disabled (<Source>.SetDuplicates)<Source>.Add,
<HFSQL file>.ExecuteQuery,
<HFSQL file>.ExecuteSQLQuery,
<Source>.Modify
hCheckIntegrityChecks the integrity of operation even if the automatic integrity check is disabled (<Cnt>.SetIntegrity)<Source>.Add,
<HFSQL file>.ExecuteQuery,
<HFSQL file>.ExecuteSQLQuery,
<Source>.Modify,
<HFSQL file>.Cross,
<Source>.Delete
hCheckMemoStandard reindexing with memo check and correction if necessary (used to retrieve the damaged memos)<Source>.Index
hViewAddCreate a view with addition: Stores the content of the view next time <Source>.ExecuteView is called<Source>.CreateView, <Source>.MergeView
hViewLockingLock records read in the file and included in the view<Source>.CreateView, <Source>.MergeView
hViewDefaultDefault creation of view<Source>.CreateView, <Source>.MergeView
hViewPostponedThe view is created but it will be run later by <Source>.ExecuteView<Source>.CreateView, <Source>.MergeView
hViewDistinctCreate view without duplicates with respect to the sort key<Source>.CreateView, <Source>.MergeView
hViewExclusiveLock the entire source file to reduce the view creation time<Source>.CreateView, <Source>.MergeView
hViewBreakableInterrupt view creation by pressing the ESC key<Source>.CreateView
hViewIntersectionMerge views with intersection: Common rows between the two specified views<Source>.MergeView
hViewJoinJoin between the first view and the second view.<Source>.MergeView
hViewSubtractionMerge views with subtraction: Row of the first view without the common rows of the second view<Source>.MergeView
hViewUnionMerging views: Merge the rows of the two specified views<Source>.MergeView
hViewUnionExExclusive merge of views: Merge the non-common rows of the two specified views<Source>.MergeView
hWDLThe files are sought:
  1. In the main WDL.
  2. In the WDL according to their load order, then on disk or in the specified WDL, then on disk.
  3. In the main WDL of the component.
  4. In the secondary WDLs of the component according to the load order.
<Source>.ChangeLocation,
<Source>.Declare
opCancelThis constant must be returned by the procedure or window used to customize the process of HFSQL errors.
The function that triggered the error returns an error and the code continues to run.
<Source>.OnError
opEndProgramThis constant must be returned by the procedure or window used to customize the process of HFSQL errors.
The function that triggered the error returns an error and the program stops. Equivalent to the following line of code:
IF NOT <HFSQL function> THEN EndProgram()
<Source>.OnError
opEndProcessThis constant must be returned by the procedure or window used to customize the process of HFSQL errors.
The function that triggered the error returns an error and the current process stops. Equivalent to the following line of code:
IF NOT <HFSQL function> THEN SetFocusAndReturnToUserInput()
<Source>.OnError
opRetryThis constant must be returned by the procedure or window used to customize the process of HFSQL errors.
In this case, the function that triggered the error is re-run.
<Source>.OnError
opRelaunchProgramThis constant must be returned by the procedure or window used to customize the process of HFSQL errors.
The program stops and the application is automatically restarted.
<Source>.OnError
New in version 23
The following constants are used to manage HFSQL data files (prefix syntax):
ConstantDescriptionFunctions/Properties
eltSetOfProceduresThe listed element is a set of procedures<Cnt>.ListStoredElement
eltProcedureThe listed element is a stored procedure<Cnt>.ListStoredElement
eltQueryThe listed element is a query.<Cnt>.ListStoredElement
Versions 15 and later
h3G
New in version 15
h3G
h3G
Type of network to simulate: 3G<Cnt>.SimulateNetwork
hAcceptOpenedFileAllows you to read the source file that will be added to the memo if this source file is opened in write mode somewhere else.<Source>.LinkMemo
hAccessHF7Pseudo-connection to HFSQL Classic database.HConnect,
<Source>.DeclareExternal,
HDescribeConnection,
HListFile,
<Cnt>.OpenConnection,
Provider property,
CtOLEDBProvider property,
CtDescribedOLEDBProvider property
hAccessHFClientServerProvider that will be used for the connection: Native Connector to an HFSQL Client/Server databaseHConnect,
<Source>.DeclareExternal,
HDescribeConnection,
HListFile,
<Cnt>.OpenConnection,
Provider property,
CtOLEDBProvider property,
CtDescribedOLEDBProvider property
hAccessJDBCMySQLAccess to a MySQL database via a JDBC driverHDescribeConnection,
<Cnt>.OpenConnection
hAccessJDBCSQLServerAccess to an SQL Server database via a JDBC driverHDescribeConnection,
<Cnt>.OpenConnection
hNativeAccessAS400Provider that will be used for the connection: Native AS/400 Connector (optional module of WINDEV)HConnect,
<Source>.DeclareExternal,
HDescribeConnection,
HListFile,
<Cnt>.OpenConnection,
Provider property,
CtOLEDBProvider property,
CtDescribedOLEDBProvider property
hNativeAccessDB2OLE DB provider that will be used for the connection: Native DB2 Connector (optional module of WINDEV)HConnect,
<Source>.DeclareExternal,
HDescribeConnection,
HListFile,
<Cnt>.OpenConnection,
Provider property,
CtOLEDBProvider property,
CtDescribedOLEDBProvider property
hNativeAccessInformixOLE DB provider that will be used for the connection: Native Informix Connector (optional module of WINDEV)HConnect,
<Source>.DeclareExternal,
HDescribeConnection,
HListFile,
<Cnt>.OpenConnection,
Provider property,
CtOLEDBProvider property,
CtDescribedOLEDBProvider property
Versions 20 and later
hNativeAccessMariaDB
New in version 20
hNativeAccessMariaDB
hNativeAccessMariaDB
OLE DB provider that will be used for the connection: Native MariaDB Connector (optional module of WINDEV/WEBDEV)HConnect,
<Source>.DeclareExternal,
HDescribeConnection,
HListFile,
<Cnt>.OpenConnection,
Provider property,
CtOLEDBProvider property,
CtDescribedOLEDBProvider property
hNativeAccessMySQLOLE DB provider that will be used for the connection: Native MySQL ConnectorHConnect,
<Source>.DeclareExternal,
HDescribeConnection,
HListFile,
<Cnt>.OpenConnection,
Provider property,
CtOLEDBProvider property,
CtDescribedOLEDBProvider property
hNativeAccessOracleOLE DB provider that will be used for the connection: Native Oracle Connector (optional module of WINDEV)HConnect,
<Source>.DeclareExternal,
HDescribeConnection,
HListFile,
<Cnt>.OpenConnection,
Provider property,
CtOLEDBProvider property,
CtDescribedOLEDBProvider property
hNativeAccessOracleLiteProvider that will be used for the connection: Native Oracle Connector (optional module of WINDEV Mobile)HConnect,
<Source>.DeclareExternal,
HDescribeConnection,
HListFile,
<Cnt>.OpenConnection,
Provider property,
CtOLEDBProvider property,
CtDescribedOLEDBProvider property
hNativeAccessPostgreSQLOLE DB provider that will be used for the connection: Native PostgreSQL ConnectorHConnect,
<Source>.DeclareExternal,
HDescribeConnection,
HListFile,
<Cnt>.OpenConnection,
Provider property,
CtOLEDBProvider property,
CtDescribedOLEDBProvider property
hNativeAccessProgressOLE DB provider that will be used for the connection: Native Progress Connector (optional module of WINDEV)HConnect,
<Source>.DeclareExternal,
HDescribeConnection
HListFile,
<Cnt>.OpenConnection,
Provider property,
CtOLEDBProvider property,
CtDescribedOLEDBProvider property
Versions 16 and later
hNativeAccessSQLAzure
New in version 16
hNativeAccessSQLAzure
hNativeAccessSQLAzure
OLE DB provider that will be used for the connection: Native SQL Azure ConnectorHConnect,
<Source>.DeclareExternal,
HDescribeConnection,
HListFile,
<Cnt>.OpenConnection,
Provider property,
CtOLEDBProvider property,
CtDescribedOLEDBProvider property
Versions 15 and later
hNativeAccessSQLite
New in version 15
hNativeAccessSQLite
hNativeAccessSQLite
OLE DB provider that will be used for the connection: Native Connector to an SQLite databaseHConnect,
<Source>.DeclareExternal,
HDescribeConnection,
HListFile,
<Cnt>.OpenConnection,
Provider property,
CtOLEDBProvider property,
CtDescribedOLEDBProvider property
hNativeAccessSQLServerOLE DB provider that will be used for the connection: Native SQL Server Connector (optional module of WINDEV)HConnect,
<Source>.DeclareExternal,
HDescribeConnection,
HListFile,
<Cnt>.OpenConnection,
Provider property,
CtOLEDBProvider property,
CtDescribedOLEDBProvider property
hNativeAccessSQLServerMobileProvider that will be used for the connection: Native SQL Server Mobile Connector (optional module of WINDEV Mobile)HConnect,
<Source>.DeclareExternal,
HDescribeConnection,
HListFile,
<Cnt>.OpenConnection,
Provider property,
CtOLEDBProvider property,
CtDescribedOLEDBProvider property
hNativeAccessSybaseOLE DB provider that will be used for the connection: Native Sybase Connector (optional module of WINDEV)HConnect,
<Source>.DeclareExternal,
HDescribeConnection,
HListFile,
<Cnt>.OpenConnection,
Provider property,
CtOLEDBProvider property,
CtDescribedOLEDBProvider property
hNativeAccessXBaseOLE DB provider that will be used for the connection: Native xBase ConnectorHConnect,
<Source>.DeclareExternal,
HDescribeConnection,
HListFile,
<Cnt>.OpenConnection,
Provider property,
CtOLEDBProvider property,
CtDescribedOLEDBProvider property
hNativeAccessXMLProvider that will be used for the connection: Native XML Connector (included with WINDEV/WEBDEV)HConnect,
<Source>.DeclareExternal,
HDescribeConnection,
HListFile,
<Cnt>.OpenConnection,
Provider property,
CtOLEDBProvider property,
CtDescribedOLEDBProvider property
Versions 23 and later
hActiveDirectory
New in version 23
hActiveDirectory
hActiveDirectory
Enable the authentication via Active Directory. <Cnt>.SetServer
Versions 15 and later
hADSL
New in version 15
hADSL
hADSL
Type of network to simulate: ADSL<Cnt>.SimulateNetwork
hAffectBrowseAddition affecting the current browse<Source>.Add,
<Source>.Modify
hApplicationProperty of a database found on an HFSQL server: Name of the application from which the database was created.HInfoDatabaseProperty,
HInfoFileProperty
hStoppedServer stoppedHServerStatus
Versions 15 and later
hNone
New in version 15
hNone
hNone
Used to disable the simulation of a specific network.<Cnt>.SimulateNetwork
hAllowedThe relevant rights are granted to the user or group.HModifyDatabaseRights,
HModifyFileRights,
HModifyServerRights
hWithFilterIf this parameter is specified:
  • the query result corresponds to a selection of filter records if the HFSQL engine allows it. Otherwise, the query result corresponds to an HFSQL view
  • the following operations are not allowed: search on the query result, query on query, view on query, query on view.
  • the browse items specified when looping through the result are ignored.
  • the magnifier is not available for the tables linked to a query.
  • hNbRec cannot be used on the queries.
If this parameter is not specified (by default):
  • the query result corresponds to an HFSQL view
  • the following operations can be performed on the queries: search on the query result, query on query, view on query, query on view.
  • the browse items specified when looping through the result are taken into account.
  • the magnifier is available on tables linked to a query.
  • hNbRec can be used on the queries.
HExecuteQuery,
HExecuteSQLQuery
hWithTransactionThe query is run in a transaction. A transaction is started, the records are locked in read/write during the execution of the query and they are unlocked at the end of its execution, regardless of the result (failure or success).
If the query cannot end properly (locked records, power failure, etc.), the transaction is canceled and the data files are restored to their previous status (before the query execution).
Remark: The query execution may be slowed down.
HExecuteQuery,
HExecuteSQLQuery
hLockWriteType of lock: Lock in write mode<Source>.Add,
HForward,
HLockFile,
HLockRecNum,
HLast,
HWrite,
HRead,
HReadLast,
HReadPrevious,
HReadFirst,
HReadSeekLast,
HReadSeekFirst,
HReadNext,
<Source>.Modify,
HPrevious,
HFirst,
HCross,
HSeek,
HSeekLast,
HSeekFirst,
HBackward,
HNext
hLockReadWriteType of lock: Lock in read/write<Source>.Add,
HForward,
HLockFile,
HLockRecNum,
HLast,
HWrite,
HRead,
HReadLast,
HReadPrevious,
HReadFirst,
HReadSeekLast,
HReadSeekFirst,
HReadNext,
<Source>.Modify,
HPrevious,
HFirst,
HCross,
HSeek,
HSeekLast,
HSeekFirst,
HBackward,
HNext
hLockNoType of lock: No lock<Source>.Add,
HForward,
HLockFile,
HLockRecNum,
HLast,
HWrite,
HRead,
HReadLast,
HReadPrevious,
HReadFirst,
HReadSeekLast,
HReadSeekFirst,
HReadNext,
<Source>.Modify,
HPrevious,
HFirst,
HCross,
HSeek,
HSeekLast,
HSeekFirst,
HBackward,
HNext
Versions 21 and later
hCacheNbUnusedFiles
New in version 21
hCacheNbUnusedFiles
hCacheNbUnusedFiles
Maximum number of unused HFSQL tables that are stored in cache (which means opened) on the server. <Cnt>.SetServer
Versions 18 and later
hAutoStatisticalCalc
New in version 18
hAutoStatisticalCalc
hAutoStatisticalCalc
Enable the automatic calculation of statistics for the data files (optimization of indexes).<Cnt>.SetServer
hCardinalityIntegrity constraints: Check the link cardinalities.<Cnt>.SetIntegrity
hInfiniteCardinalityMaximum cardinality ("N")MaxLinkedCardinality property,
MaxSourceCardinality property
hChangeCharsetThe character set defined by ChangeCharset will be taken into account in the new data file. Sorts, searches, ... on string keys (strings, characters, date and time) will be performed according to this character set.<Source>.Creation,
<Source>.CreationIfNotFound,
<Source>.Index
hDatabasePathPath of directory containing all databases<Cnt>.SetServer
hJNLPathPath of the directory containing all the logs of the different HFSQL Client/Server applications<Cnt>.SetServer
hJNLBackupPathPath of the directory containing the backups of the logs<Cnt>.SetServer
hLogPathPath of the directory containing the log files<Cnt>.SetServer
hActivityStatisticsPathPath of the directory containing the activity statistics<Cnt>.SetServer
hDuplicateKeyCharacteristics of an item: Key with duplicatesKeyType property
hUniqueKeyCharacteristics of an item: Unique keyKeyType property
Versions 20 and later
hSQLCode
New in version 20
hSQLCode
hSQLCode
Requested information: SQL code of the materialized view
Versions 20 and later
<Cnt>.InfoView
New in version 20
<Cnt>.InfoView
<Cnt>.InfoView
hCompatibleThe structures of the data files (defined in the analysis and found in the physical file) must be compatible.<Source>.CheckStructure
hPackNoCompression mode: No compressionMmoPackMethod property
hPackZLWCompression mode: Compression based on the Ziw-Lempel algorithm, Welch implementation.MmoPackMethod property
hKeepTRSStores the transaction files during the deletion<Cnt>.DeleteDatabase,
<Cnt>.DeleteFile
hCopyAutoIDCopies the automatic identifier while keeping its value<Source>.CopyRecord,
<Source>.ImportHF55,
<Source>.ImportText,
Versions 20 and later
<Source>.ImportXLS
New in version 20
<Source>.ImportXLS
<Source>.ImportXLS
hCopyIndexCopies the index of the data file<Cnt>.CopyFile
hCopyIfNotFoundCopies the data file only if it does not exist at the specified location on the destination computer.<Cnt>.CopyFile
hCorrespondenceGives the correspondence between the numbers of the log functions and the names of the WLanguage functionsHInfoLog
hCreatorProperty of a database found on an HFSQL server: Name of database owner.<Cnt>.InfoDatabaseProperty,
<Cnt>.InfoFileProperty
hCreateIndexThe index of the data file is not copied. It is automatically recreated at the destination by reindexing.<Cnt>.CopyFile
hIncreasingSort performed in ascending orderSortType property
Versions 24 and later
hCryptAES128
New in version 24
hCryptAES128
hCryptAES128
File encryption performed only if a password is defined for the file. In this case, the file is encrypted using a 128-bit AES algorithm with Output feedback (OFB).FicCryptMethod property,
MmoCryptMethod property,
NdxCryptMethod property
Versions 19 and later
hEncryptionAuto
New in version 19
hEncryptionAuto
hEncryptionAuto
File encryption performed only if a password is defined for the file. In this case, the data file is encrypted according to an optimized encryption algorithm (RC5 16 rounds on 128 bits).FicCryptMethod property,
MmoCryptMethod property,
NdxCryptMethod property
hEncryptionNONo file encryption.FicCryptMethod property,
MmoCryptMethod property,
NdxCryptMethod property
hEncryptionRC5_12The file is encrypted according to an optimized encryption algorithm (RC5 12 rounds on 128 bits).FicCryptMethod property,
MmoCryptMethod property,
NdxCryptMethod property
hEncryptionRC5_16The file is encrypted according to an optimized encryption algorithm (RC5 16 rounds on 128 bits).FicCryptMethod property,
MmoCryptMethod property,
NdxCryptMethod property
hEncryptionStandardThe memo file is encrypted according to an optimized encryption algorithm on 128 bits.FicCryptMethod property,
MmoCryptMethod property,
NdxCryptMethod property
hClientCursorCursor managed by MDAC. Offers more features than a server cursor. A client cursor must necessarily be a static cursorHDescribeConnection,
<Cnt>.OpenConnection
hDynamicCursorCursor offering a lot of features but consuming a lot of memory. This cursor allows all types of moves. It allows you to access all the modifications, additions and deletions performed by the other users.HDescribeConnection,
<Cnt>.OpenConnection
hForwardOnlyCursorFast cursor consuming little memory. The move is performed from the first record to the last one. The data modified by the other users is not visible.HDescribeConnection,
<Cnt>.OpenConnection
hReadOnlyCursorThe set of records cannot be modified.HDescribeConnection,
<Cnt>.OpenConnection
hOpenKeysetCursorCursor that handles a fixed set of records. Only the keys corresponding to the record are stored and not the records (consumes less memory). The deleted records can no longer be accessed. Modifications performed by other users are visible (but records added are not).HDescribeConnection,
<Cnt>.OpenConnection
hOptimisticCursorThe record is locked when it is updatedHDescribeConnection,
<Cnt>.OpenConnection
hPessimisticCursorThe record is locked as soon as it goes into edit mode to be modified.HDescribeConnection,
<Cnt>.OpenConnection
hServerCursorCursor managed by the database. This cursor can easily apply the changes performed by the other users to the data.HDescribeConnection,
<Cnt>.OpenConnection
hStaticCursorMakes a copy of all query records in memory (high memory usage). All types of moves are allowed.HDescribeConnection,
<Cnt>.OpenConnection
hDaemonUserUsername that will be used by the server (Linux only)<Cnt>.SetServer
hDateProperty of a database found on an HFSQL server: Creation date of the database.<Cnt>.InfoDatabaseProperty, <Cnt>.InfoFileProperty
Versions 20 and later
hDateLastRefresh
New in version 20
hDateLastRefresh
hDateLastRefresh
Requested information: Date of the last successful refresh for the materialized view.
Versions 20 and later
<Cnt>.InfoView
New in version 20
<Cnt>.InfoView
<Cnt>.InfoView
hDBASCIISort according to ASCII orderHDBSortType
hDisconnectionConfigures the disconnection messageHOnServerCall
hDBLexicographicSort according to the lexicographic orderHDBSortType
hDecreasingSort performed in descending orderSortType property
hDefaultThe rights returned do not take the inherited rights into account (rights granted to the groups to which the user belongs).
If no rights were defined, the value will be set to hInherit.
<Result> contains the values of the requested rights (in the same order).
<Cnt>.InfoDatabaseRights,
<Cnt>.InfoFileRights,
<Cnt>.InfoServerRights
hStartedServer startedHServerStatus
hDetailsThe rights returned do not take the inherited rights into account (rights granted to the groups to which the user belongs).
If no rights were defined, the value will be set to hInherit.
<Result> contains the rights and there value.
<Cnt>.InfoDatabaseRights,
<Cnt>.InfoFileRights,
<Cnt>.InfoServerRights
hDestroyLinkDeletes all links related to the deleted data file.<Cnt>.DeleteFile
hDiskSearch mode for the data files or the analyses: The files are sought on the disk only. This is the most common case<Source>.ChangeLocation,
<Source>.Declare
hDistinctManagement of duplicates during the browse: Only one record is read if duplicates are found when looping through a key item<Source>.Forward,
<Source>.ReadPrevious,
<Source>.ReadNext,
<Source>.Previous,
<Source>.Backward,
<Source>.Next
hDataConfigure the file management: All the operations stored in the log file are applied to the existing file<Cnt>.RegenerateFile
hRightsInsertRights to add new records into a data file.<Cnt>.InfoDatabaseRights,
<Cnt>.InfoFileRights,
<Cnt>.ModifyDatabaseRights,
<Cnt>.ModifyFileRights
hRightsStopServerRights to stop a server (<Connection>.StopServer)<Cnt>.InfoServerRights,
<Cnt>.ModifyServerRights
hRightsLockRights to lock the data files or the records of a data file.<Cnt>.InfoDatabaseRights,
<Cnt>.InfoFileRights,
<Cnt>.ModifyDatabaseRights,
<Cnt>.ModifyFileRights
hRightsChangeRightsRights to change rights.<Cnt>.InfoDatabaseRights,
<Cnt>.InfoFileRights,
<Cnt>.InfoServerRights,
<Cnt>.ModifyDatabaseRights,
<Cnt>.ModifyFileRights,
<Cnt>.ModifyServerRights
hRightsChangeLinkRights to modify the integrity rules on a data file.<Cnt>.InfoDatabaseRights,
<Cnt>.InfoFileRights,
<Cnt>.ModifyDatabaseRights,
<Cnt>.ModifyFileRights
hRightsChangePasswordRights to change the password of a user on the server (the user can change his own password and the administrator can change the password of each user).<Cnt>.InfoServerRights,
<Cnt>.ModifyServerRights
hRightsChangeOwnerRights to modify the owner of an element<Cnt>.InfoDatabaseRights,
<Cnt>.InfoFileRights,
<Cnt>.ModifyDatabaseRights,
<Cnt>.ModifyFileRights
hRightsConnectionRights to connect to a server (encrypted or unencrypted connection)<Cnt>.InfoDatabaseRights,
<Cnt>.ModifyDatabaseRights
hRightsEncryptedConnectionRights to connect to a server (encrypted connection only)<Cnt>.InfoDatabaseRights,
<Cnt>.ModifyDatabaseRights
hRightsCreateDBRights to create a database<Cnt>.InfoServerRights,
<Cnt>.ModifyServerRights
hRightsCreateFileRights to create a data file (with <Source>.Creation)<Cnt>.InfoDatabaseRights,
<Cnt>.ModifyDatabaseRights
Versions 20 and later
hRightsCreateView
New in version 20
hRightsCreateView
hRightsCreateView
Rights to create a SQL view or a materialized view.<Cnt>.InfoDatabaseRights,
<Cnt>.ModifyDatabaseRights
hRightsDebugRights to debug the stored procedures.<Cnt>.InfoDatabaseRights,
<Cnt>.ModifyDatabaseRights
hRightsDisconnectClientRights to disconnect the client computers.<Cnt>.InfoServerRights,
<Cnt>.ModifyServerRights
hRightsSendMessageToClientRights to send messages to the client computers.<Cnt>.InfoServerRights,
<Cnt>.ModifyServerRights
hRightsRunProcedureRights to run the stored procedures.<Cnt>.InfoDatabaseRights,
<Cnt>.ModifyDatabaseRights
hRightsManageDuplicateRights to enable and disable the management of duplicates.<Cnt>.InfoDatabaseRights,
<Cnt>.InfoFileRights,
<Cnt>.ModifyDatabaseRights,
<Cnt>.ModifyFileRights
hRightsManageIntegrityRights to enable and disable the management of integrity.<Cnt>.InfoDatabaseRights,
<Cnt>.ModifyDatabaseRights
hRightsManageTaskRights to manage the scheduled tasks.<Cnt>.InfoServerRights,
<Cnt>.ModifyServerRights
hRightsManageProcedureRights to add, modify and delete the stored procedures.<Cnt>.InfoDatabaseRights,
<Cnt>.ModifyDatabaseRights
hRightsManageServerRights to use <Cnt>.SetServer<Cnt>.InfoServerRights,
<Cnt>.ModifyServerRights
hRightsManageTriggerRights to manage the server triggers (addition, activation, deletion)<Cnt>.InfoDatabaseRights,
<Cnt>.ModifyDatabaseRights
hRightsManageUserRights to delete and add users or groups<Cnt>.InfoServerRights,
<Cnt>.ModifyServerRights
hRightsNoDatabaseAccessRights to prevent access to a database (<Cnt>.NoDatabaseAccess and <Cnt>.EndNoDatabaseAccess)<Cnt>.InfoDatabaseRights,
<Cnt>.ModifyDatabaseRights
hRightsReadRights to read the records of a data file<Cnt>.InfoDatabaseRights,
<Cnt>.InfoFileRights,
<Cnt>.ModifyDatabaseRights,
<Cnt>.ModifyFileRights
hRightsReadLogStatRights to see the activity statistics and the server logs.<Cnt>.InfoServerRights,
<Cnt>.ModifyServerRights
hRightsMaintenanceRights to start a re-index operation or to perform statistical calculations on a data file<Cnt>.InfoDatabaseRights,
<Cnt>.InfoFileRights,
<Cnt>.ModifyDatabaseRights,
<Cnt>.ModifyFileRights
hRightsAutoModifRights to perform the automatic modification of the data files on a file<Cnt>.InfoDatabaseRights,
<Cnt>.InfoFileRights,
<Cnt>.ModifyDatabaseRights,
<Cnt>.ModifyFileRights
hRightsUpdateRights to modify the records of a data file<Cnt>.InfoDatabaseRights,
<Cnt>.InfoFileRights,
<Cnt>.ModifyDatabaseRights,
<Cnt>.ModifyFileRights
hRightsPriorityRights to modify the priority of a client application<Cnt>.InfoServerRights,
<Cnt>.ModifyServerRights
Versions 18 and later
hRightsServerReplication
New in version 18
hRightsServerReplication
hRightsServerReplication
Rights to define and perform a replication between two HFSQL servers.<Cnt>.InfoServerRights,
<Cnt>.ModifyServerRights
hRightsBackupRights to save the data files<Cnt>.InfoDatabaseRights,
<Cnt>.InfoServerRights,
<Cnt>.ModifyDatabaseRights,
<Cnt>.ModifyServerRights
hRightsDeleteRights to delete the records from a data file<Cnt>.InfoDatabaseRights,
<Cnt>.InfoFileRights,
<Cnt>.ModifyDatabaseRights,
<Cnt>.ModifyFileRights
hRightsDeleteDBRights to delete a database<Cnt>.InfoDatabaseRights,
<Cnt>.ModifyDatabaseRights
hRightsDeleteFileRights to delete a data file (<Cnt>.DeleteFile)<Cnt>.InfoDatabaseRights,
<Cnt>.InfoFileRights,
<Cnt>.ModifyDatabaseRights,
<Cnt>.ModifyFileRights
Versions 20 and later
hRightsDeleteView
New in version 20
hRightsDeleteView
hRightsDeleteView
Rights to delete a SQL view or a materialized view.<Cnt>.InfoViewRights, <Cnt>.ModifyViewRights
hRightsAllList of all the rights<Cnt>.InfoDatabaseRights,
<Cnt>.InfoFileRights,
<Cnt>.InfoServerRights
hRightsSeeUserRights to view the characteristics of a group or user.<Cnt>.InfoServerRights,
<Cnt>.ModifyServerRights
hlbDiskAccessValue modifying the coefficient applied to the counter for the number of disk accesses.<Cnt>.SetServer
hlbActiveEnable or disable the load balancing<Cnt>.SetServer
hlbClientCallsValue modifying the coefficient applied to the counter for client calls<Cnt>.SetServer
hlbMaxTimeoutValue modifying the maximum timeout for a server request<Cnt>.SetServer
hlbDiskValue modifying the coefficient applied to the counter for the bytes read or written on disk by the server<Cnt>.SetServer
hlbSentValue modifying the coefficient applied to the counter for the bytes sent by the server<Cnt>.SetServer
hlbReceivedValue modifying the coefficient applied to the counter for the bytes received by the server<Cnt>.SetServer
hWriteDefaultAddition not affecting the current browse/Identifier re-used or calculated for the record<Source>.Add,
<Source>.Write,
<Source>.Modify
hEffectiveThe rights returned correspond to the rights that will be actually granted to the user or to the group on the database. The inherited rights are taken into account (rights granted to the groups to which the user belongs for example).<Cnt>.InfoDatabaseRights,
<Cnt>.InfoFileRights,
<Cnt>.InfoServerRights
hOnUpdateIntegrity rule applied during a modification<Cnt>.SetIntegrity
hRecFileRecord to read: Value of the item currently saved in the data file<Source>.ErrorModification,
<Source>.ErrorStatusModification
hRecReadRecord to read: Value of the item for the source record<Source>.ErrorModification,
<Source>.ErrorStatusModification
hRecUserRecord to read: Value of the item for the current record when performing the modification<Source>.ErrorModification,
<Source>.ErrorStatusModification
hOnDeleteIntegrity rule applied during a deletion<Cnt>.SetIntegrity
hErrDatabaseAccessConfigure the access errors to an HFSQL Client/Server database.<Source>.OnError
hErrADOType of information about the error to return: Error code returned by ADO. The corresponding message is returned by the hErrADOMessage constant.HErrorInfo
hErrBaseType of information about the error to return: Error code returned by the database. The corresponding message is returned by the hErrBaseMessage constantHErrorInfo
hErrLockCustomize lock errors<Source>.OnError
hErrSystemCodeType of information about the error to return: Number of the associated system errorHErrorInfo
hErrFullDetailsType of information about the error to return: Full error details (error line, current process, etc.)
Remark: Returns the same information as the one retrieved via the "Copy" button in the WLanguage error window.
HErrorInfo
hErrDuplicatesCustomize duplicate errors<Source>.OnError
hErrCurrentType of information about the error to return: Number of the current errorHError
Versions 20 and later
hErrorLastRefresh
New in version 20
hErrorLastRefresh
hErrorLastRefresh
Requested information: Last error while refreshing the materialized view.
Versions 20 and later
<Connection>.InfoView
New in version 20
<Connection>.InfoView
<Connection>.InfoView
hErrFICType of information about the error to return: Full name of the data file associated with the errorHErrorInfo
hErrFileType of information about the error to return: Logical name of data file associated with the errorHErrorInfo
hErrLockInfoType of information about the error to return: Information about the lockHErrorInfo
hErrClientInfoInformation about the client layer used by the Native Connector that returned the error.HErrorInfo
hErrDebugInfoType of information about the error to return: Specific information for debugging the problem that occurred. This information should only be displayed and communicated on express demand from PC SOFT.
When running a query via OLE DB, this option allows you to retrieve the code of the SQL query currently run on the database.
HErrorInfo
hErrServerInfoInformation about the server used by the Native Connector that returned the error.HErrorInfo
hErrIntegrityCustomize integrity errors<Source>.OnError
hErrLinkType of information about the error to return: Name of the link associated with the errorHErrorInfo
hErrMessageType of information about the error to return: Message associated with the errorHErrorInfo
hErrADOMessageType of information about the error to return: Message corresponding to the error returned by ADO (hErrADO)HErrorInfo
hErrBaseMessageType of information about the error to return: Message corresponding to the error returned by the database (hErrBase)HErrorInfo
hErrNativeMessageType of information about the error to return: Message corresponding to the error returned by the provider of the Native Connector.HErrorInfo
hErrOLEDBMessageType of information about the error to return: Message corresponding to the error returned by the system during an OLE DB connection (hErrOLEDB)HErrorInfo
hErrSystemMessageType of information about the error to return: Message of associated system errorHErrorInfo
hErrMMOType of information about the error to return: Full name of the memo file associated with the errorHErrorInfo
hErrModifyCustomize a modification conflict<Source>.OnError
hErrPasswordCustomize password errors<Source>.OnError
hErrNativeType of information about the error to return: Error code returned by the Native Connector or the OLE DB provider usedHErrorInfo
hErrNDXType of information about the error to return: Full name of the index file associated with the errorHErrorInfo
hErrRecNumType of information about the error to return: Number of the record associated with the errorHErrorInfo
hErrOLEDBType of information about the error to return: Error code returned by the system during an access via an OLE DB connection.HErrorInfo
hErrConnectionLossCustomize the errors caused by a loss of connection with the server.<Source>.OnError
Versions 20 and later
hErrPositionSQLError
New in version 20
hErrPositionSQLError
hErrPositionSQLError
Type of information about the error to return: Position of the SQL error in the SQL code of the query run by <HFSQL file>.ExecuteSQLQuery.HErrorInfo
hErrMainType of information about the error to return: Number of the main errorHError
hErrIndexCustomize reindexing errors (reindexing in progress when accessing the data file)<Source>.OnError
hErrItemType of information about the error to return: Name of the item associated with the errorHErrorInfo
hErrServerType of information about the error to return: Name of the HFSQL Client/Server server that triggers the errorHErrorInfo
hErrAllCustomize all errors<Source>.OnError
hErrNeedValueCustomize errors caused by a required value that has not been specified (OLE DB only).<Source>.OnError
hErrWDDType of information about the error to return: Full name of the analysis file associated with the errorHErrorInfo
hStateActiveStatus of the record/Type of record taken into account: Active record<Source>.State,
<Source>.NbRec,
<Source>.ErrorStatusModification
hStateInvalidRecord status not found (error)<Source>.State,
<Source>.ErrorStatusModification
hStateCrossedStatus of the record/Type of record taken into account: Crossed record<Source>.State,
<Source>.NbRec,
<Source>.ErrorStatusModification
hStateDelStatus of the record/Type of record taken into account: Deleted record<Source>.State,
<Source>.NbRec,
<Source>.ErrorStatusModification
hStateAllType of record: Total number of records in the data file<Source>.NbRec
hExistingType of search: Only the assignments for which a file actually existsHListREP
hExpCreationMode for creating the export file: The file is overwritten if it already exists.<Source>.ExportXML
Versions 21 and later
<Source>.ExportJSON
New in version 21
<Source>.ExportJSON
<Source>.ExportJSON
Versions 24 and later
<Source>.ExportCSV
New in version 24
<Source>.ExportCSV
<Source>.ExportCSV
Versions 24 and later
<Source>.ExportXLS
New in version 24
<Source>.ExportXLS
<Source>.ExportXLS
hExpBreakableMode for creating the export file: The export can be interrupted by pressing Esc.
If the export is interrupted, the export file is valid and it only contains the records exported before the interruption.
<Source>.ExportXML
Versions 21 and later
<Source>.ExportJSON
New in version 21
<Source>.ExportJSON
<Source>.ExportJSON
Versions 24 and later
<Source>.ExportCSV
New in version 24
<Source>.ExportCSV
<Source>.ExportCSV
Versions 24 and later
<Source>.ExportXLS
New in version 24
<Source>.ExportXLS
<Source>.ExportXLS
hExpNormalMode for creating the export file: Standard operating mode<Source>.ExportXML
Versions 21 and later
<Source>.ExportJSON
New in version 21
<Source>.ExportJSON
<Source>.ExportJSON
Versions 24 and later
<Source>.ExportCSV
New in version 24
<Source>.ExportCSV
<Source>.ExportCSV
Versions 24 and later
<Source>.ExportXLS
New in version 24
<Source>.ExportXLS
<Source>.ExportXLS
Versions 24 and later
hExpNoLineItemName
New in version 24
hExpNoLineItemName
hExpNoLineItemName
Mode for creating the CSV/XLSX file: The first line of the generated file will not contain the names of the items.
Versions 24 and later
<Source>.ExportCSV
New in version 24
<Source>.ExportCSV
<Source>.ExportCSV
Versions 24 and later
<Source>.ExportXLS
New in version 24
<Source>.ExportXLS
<Source>.ExportXLS
hExpWithoutXSLThe style sheet (".XSL" file) is not created<Source>.ExportXML
hFileAS400Type of file: AS400 fileType property
hFileOtherType of file: Other type of fileType property
hFileClientServerType of file: HFSQL Client/Server fileType property
hFileHF5Type of file: Hyper File 5 fileType property
hFileMySQLType of file: MySQL fileType property
hFileNormalType of file: Standard file (HFSQL Classic)Type property
hFileOLEDBType of file: OLEDB fileType property
hFileOracleType of file: ORACLE fileType property
hFileOracleLiteType of file: ORACLE Lite fileType property
Versions 15 and later
hFilePostgreSQL
New in version 15
hFilePostgreSQL
hFilePostgreSQL
Type of file: PostgreSQL fileType property
hFileProgressType of file: Progress fileType property
hFileQueryType of file: QueryType property
hFileQueryAS400Type of file: Query on an AS/400 databaseType property
hFileQueryClientServerType of file: Query on an HFSQL Client/Server databaseType property
hFileQueryMySQLType of file: Query on a MySQL databaseType property
hFileQueryOLEDBType of file: Query on a database accessed via an OLE DB providerType property
hFileQueryOracleType of file: Query on an Oracle databaseType property
hFileQueryOracleLiteType of file: Query on an Oracle Lite databaseType property
Versions 15 and later
hFileQueryPostgreSQL
New in version 15
hFileQueryPostgreSQL
hFileQueryPostgreSQL
Type of file: Query on a PostgreSQL databaseType property
hFileQueryProgressType of file: Query on a Progress databaseType property
Versions 16 and later
hFileQuerySQLAzure
New in version 16
hFileQuerySQLAzure
hFileQuerySQLAzure
Type of file: Query on an SQL Azure databaseType property
hFileQuerySQLServerType of file: Query on an SQL Server databaseType property
hFileQuerySQLServerMobileType of file: Query on an SQL Server Mobile databaseType property
hFileQuerySybaseType of file: Query on a Sybase databaseType property
hFileQueryXMLType of file: Query on an XML databaseType property
hFileSQLType of file: SQL fileType property
Versions 16 and later
hFileSQLAzure
New in version 16
hFileSQLAzure
hFileSQLAzure
Type of file: SQL Azure fileType property
Versions 16 and later
hFileSQLite
New in version 16
hFileSQLite
hFileSQLite
Type of file: SQLite fileType property
hFileSQLServerType of file: SQL Server fileType property
hFileSQLServerMobileType of file: SQL Server Mobile fileType property
hFileSybaseType of file: Sybase fileType property
hFileTemporaryType of file: Temporary fileType property
hFileViewType of file: HFSQL viewType property
hFileXBaseType of file: xBase fileType property
hFileXMLType of file: XML fileType property
hSetIDAutoMode for calculating the automatic identifier: Identifier value equals to the one stored during the addition<Source>.Add,
<Source>.Write,
<Source>.Modify
hSetIDAutoMode for calculating the automatic identifier: Identifier value equals to the one stored during the write operation<Source>.Add,
<Source>.Write,
<Source>.Modify
hANSIFormatData format: Ansi format (used by Windows)Format property
hUNICODEFormatData format: UNICODE formatFormat property
Versions 17 and later
hForwardOnly
New in version 17
hForwardOnly
hForwardOnly
Native Connectors only:
Optimizes simple iterations that do not use the following features:
  • Reading the previous record.
  • Modifying a record.
  • Saving position.
If one of these features is used, the result may differ from the expected one.
For example, this constant can be used when looping through records to populate a Table control programmatically.
<Source>.ReadLast,
<Source>.ReadFirst,
<Source>.ReadSeekFirst,
<Source>.ReadSeekLast
Versions 20 and later
hftPunctuationSimple
New in version 20
hftPunctuationSimple
hftPunctuationSimple
Full-text Index item described programmatically: Taking into account the simple punctuation characters (non Unicode).Option property of variables
of type FullTextIndex Description.
Versions 20 and later
hftPunctuationUnicode
New in version 20
hftPunctuationUnicode
hftPunctuationUnicode
Full-text Index item described programmatically: Taking into account the Unicode punctuation characters.Option property of variables
of type FullTextIndex Description.
hFTXReindexing full-text indexes<Source>.Index
HGenericType of search: Generic search<Source>.ReadSeekLast,
<Source>.ReadSeekFirst,
<Source>.SeekLast,
<Source>.SeekFirst
hHCreationIfNotFoundType of test to run to check the connection: Checks the connection by opening or creating a file (if the file does not exist). This operation can be performed in hOReadWrite mode only.HConnect
hInheritThe user will inherit from the value of the rights granted to the group to which he belongs<Cnt>.ModifyDatabaseRights,
<Cnt>.ModifyFileRights,
<Cnt>.ModifyServerRights
hHOpenType of test to run to check the connection: Checks the connection by opening a file. This value is used by default when accessing to an hORead database.HConnect
hIdenticalThe structures of files (read in the analysis and in the physical file) must be strictly identical.<Source>.ReadSeek,
<Source>.Seek,
<Source>.CheckStructure
hIgnoreDuplicatesDoes not check for duplicates for this action, even if the automatic duplicate check is enabled (<Source>.SetDuplicates)<Source>.Add
hIgnoreIntegrityIgnores the integrity check for this operation, even if the automatic integrity check is enabled (<Cnt>.SetIntegrity)<Source>.Add,
<Source>.Modify,
<Source>.Delete,
<HFSQL file>.Cross
hImpConversionType of import: The associated items do not have the same type or the same size: the data checked out from the imported file is automatically converted or truncated.<Source>.ImportHF55
hImpCreationType of import: If the (HFSQL Classic) import file exists, it is overwritten.<Source>.ImportHF55,
<Source>.ImportText,
Versions 20 and later
<Source>.ImportXLS,
New in version 20
<Source>.ImportXLS,
<Source>.ImportXLS,
<Source>.ImportXML
Versions 21 and later
<Source>.ImportJSON
New in version 21
<Source>.ImportJSON
<Source>.ImportJSON
hImpIgnoreInvalidLineType of import: The lines whose structure are invalid are not imported: the import continues on the following lines. The structure is invalid if data is missing for one or more items, or if string separators are missing.<Source>.ImportText,
Versions 20 and later
<Source>.ImportXLS
New in version 20
<Source>.ImportXLS
<Source>.ImportXLS
Versions 20 and later
hImpIgnoreFirstLine<