PC SOFT

ONLINE HELP
FOR WINDEV, WEBDEV AND WINDEV MOBILE

Home | Sign in | English US

WINDEV
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadApple WatchUniversal Windows 10 AppWindows Mobile
Others
Stored procedures
ConstantAffectsUsed by the functions or properties
eltProcedureThe listed element is a stored procedureHListStoredElement
eltQueryThe listed element is a query.HListStoredElement
eltSetOfProceduresThe listed element is a set of proceduresHListStoredElement
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, ..CtOLEDBProvider, ..CtDescribedOLEDBProvider
hAccessHFClientServerProvider that will be used for the connection: Native Access to HFSQL Client/Server databaseHConnect, HDeclareExternal,
HDescribeConnection, HListFile,
HOpenConnection,
..Provider, ..CtOLEDBProvider, ..CtDescribedOLEDBProvider
hAccessJDBCMySQLAccess to a MySQL database via a JDBC driverHDescribeConnection,
HOpenConnection
hAccessJDBCSQLServerAccess to a SQL Server database via a JDBC driverHDescribeConnection,
HOpenConnection
Versions 23 and later
hActiveDirectory
New in version 23
hActiveDirectory
hActiveDirectory
Enable the authentication via Active Directory. HSetServer
hActiveSyncFrameThe size of the frame is optimized to be used with Mobile devices.HCS.FrameSize
hActivityStatisticsPathPath of the directory containing the activity statisticsHSetServer
hActivityStatisticsPeriodIndicates the period (in second) between each backup of values for the different activity counters.HSetServer
Versions 15 and later
hADSL
New in version 15
hADSL
hADSL
Type of network to simulate: ADSLHSimulateNetwork
hAffectBrowseAddition affecting the current browseHAdd, HModify
hAllowedThe relevant rights are granted to the user or to the group.HModifyDatabaseRights,
HModifyFileRights,
HModifyServerRights
hANSIFormatFormat of data: Ansi format (used by Windows)..Format
hApplicationProperty of a database found on a HFSQL server: Name of the application from which the database was created.HInfoDatabaseProperty, HInfoFileProperty
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
Versions 15 and later
hBackgroundTask
New in version 15
hBackgroundTask
hBackgroundTask
Perform the process in background task without locking the data file (available for the data files in Client/Server mode).HStatCalculate,
HIndex
hBackupCanceledStatus of backup: Backup canceledHInfoBackup
hBackupCompletedStatus of backup: Backup completedHInfoBackup
Versions 15 and later
hBackupDifferential
New in version 15
hBackupDifferential
hBackupDifferential
Type of backup: Differential backupHInfoBackup
hBackupErrorStatus of backup: Error during backupHInfoBackup
Versions 15 and later
hBackupFull
New in version 15
hBackupFull
hBackupFull
Type of backup: Full backupHInfoBackup
hBackupInProgressStatus of backup: Backup in progressHInfoBackup
hBoundSeparatorUsed to separate the values of lower and upper bounds for the components of composite keyHFilterIncludedBetween
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
hCardinalityIntegrity constraints: Check the link cardinalities.HSetIntegrity
hChangeCharsetThe character set defined by ChangeCharset will be taken into account in the new data file. The sorts, the searches, ... on string keys (strings, characters, date and time) will be performed according to this character set.HCreation,
HCreationIfNotFound,
HIndex
hCheckDuplicatesChecks the duplicates for this operation, even if the check for duplicates 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 re-indexing with memo check and correction if necessary (used to retrieve the damaged memos)HIndex
hClientCursorCursor managed by MDAC. Offers more features than a server cursor. A client cursor must necessarily be a static cursorHDescribeConnection,
HOpenConnection
hCompatibleThe structures of the data files (defined in the analysis and found in the physical file) must be compatible.HCheckStructure
hComputerProperty of a database found on a HFSQL server: Name of the computer from which the element was created.HInfoDatabaseProperty, HInfoFileProperty
hCopyAutoIdCopies the automatic identifier while keeping its valueHCopyRecord, HImportHF55,
HImportText,
Versions 20 and later
HImportXLS
New in version 20
HImportXLS
HImportXLS
hCopyIfNotFoundCopies the data file only if it does not exist at the specified location on the destination computer.HCopyFile
hCopyIndexCopies the index of the data fileHCopyFile
hCorrespondenceGives the correspondence between the numbers of the log functions and the names of the WLanguage functionsHInfoLog
hCreateIndexThe index of the data file is not copied. It is automatically re-created on the destination by reindexing.HCopyFile
hCreatorProperty of a database found on a HFSQL server: Name of database owner.HInfoDatabaseProperty, HInfoFileProperty
Versions 19 and later
hCryptAuto
New in version 19
hCryptAuto
hCryptAuto
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, ..MmoCryptMethod, ..NdxCryptMethod
hCryptNoNo file encryption...FicCryptMethod, ..MmoCryptMethod, ..NdxCryptMethod
hCryptRC5_12The file is encrypted according to an optimized encryption algorithm (RC5 12 rounds on 128 bits)...FicCryptMethod, ..MmoCryptMethod, ..NdxCryptMethod
hCryptRC5_16The file is encrypted according to an optimized encryption algorithm (RC5 16 rounds on 128 bits)...FicCryptMethod, ..MmoCryptMethod, ..NdxCryptMethod
hCryptStandardThe memo file is encrypted according to an optimized encryption algorithm on 128 bits...FicCryptMethod, ..MmoCryptMethod, ..NdxCryptMethod
hCurrentRecNumNumber of the current record.HFSQL functions
hDaemonUserUser name that will be used by the server (Linux only)HSetServer
hDataConfigure the file management: All the operations stored in the log file are applied to the existing fileHRegenerateFile
hDatabasePathPath of the directory containing all the databasesHSetServer
hDateProperty of a database found on a 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
hDBLexicographicSort according to the lexicographic orderHDBSortType
hDebuggingPortPort used to debug the stored procedures and the server triggers.HSetServer
hDecreasingSort performed in descending order..SortType
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
hDefaultFrameThe standard size will be used by default.HCS.FrameSize
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
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
hDeleteLogDeletes the log fileHDeleteFile,
HDeleteDatabase
hDestroyLinkDeletes all the links related to the deleted data file.HDeleteFile
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 its value.
HInfoDatabaseRights,
HInfoFileRights,
HInfoServerRights
hDisconnectionConfigure the disconnection messageHOnServerCall
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: When a browse is performed on a key item, a single record is browsed if duplicates are foundHForward, HReadPrevious,
HReadNext, HPrevious,
HBackward, HNext
hDuplicateKeyCharacteristics of an item: Key with duplicates..KeyType
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
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
hErrADOType of information about the error to return: Error code returned by ADO. The corresponding message is returned by the hErrADOMessage constant.HErrorInfo
hErrADOMessageType of information about the error to return: Message corresponding to the error returned by ADO (hErrADO)HErrorInfo
hErrAllCustomize all the errorsHOnError
hErrBaseType of information about the error to return: Error code returned by the database. The corresponding message is returned by the hErrBaseMessage constantHErrorInfo
hErrBaseMessageType of information about the error to return: Message corresponding to the error returned by the database (hErrBase)HErrorInfo
hErrClientInfoInformation about the client layer used by the Native Access that returned the error.HErrorInfo
hErrConnectionLossCustomize the errors caused by a loss of connection with the server.HOnError
hErrCurrentType of information about the error to return: Number of the current errorHError
hErrDatabaseAccessConfigure the access errors to a HFSQL Client/Server database.HOnError
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
hErrDuplicatesCustomize the duplicate errorsHOnError
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
hErrFullDetailsType of information about the error to return: Full error details (error line, current process, ...)
Note: Returns the same information as the one retrieved when clicking the "Copy" button in the error window of WLanguage.
HErrorInfo
hErrIndexCustomize the re-indexing errors (re-indexing operation in progress during the access to the data file)HOnError
hErrIntegrityCustome the integrity errorsHOnError
hErrItemType of information about the error to return: Name of item associated with the errorHErrorInfo
hErrLinkType of information about the error to return: Name of link associated with the errorHErrorInfo
hErrLockCustomize the lock errorsHOnError
hErrLockInfoType of information about the error to return: Information about the lockHErrorInfo
hErrMainType of information about the error to return: Number of the main errorHError
hErrMessageType of information about the error to return: Message associated with the errorHErrorInfo
hErrMMOType of information about the error to return: Full name of the memo file associated with the errorHErrorInfo
hErrModifyCustomize a modification conflictHOnError
hErrNativeType of information about the error to return: Error code returned by the native access or the OLE DB provider usedHErrorInfo
hErrNativeMessageType of information about the error to return: Message corresponding to the error returned by the provider of native accessHErrorInfo
hErrNDXType of information about the error to return: Full name of the index file associated with the errorHErrorInfo
hErrNeedValueCustomize the errors caused by a mandatory input with no data (OLE DB only).HOnError
hErrOLEDBType of information about the error to return: Error code returned by the system during an access via an OLE DB connection.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
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
hErrPasswordCustomize the password errorsHOnError
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
hErrRecNumType of information about the error to return: Number of the record associated with the errorHErrorInfo
hErrServerType of information about the error to return: Name of the HFSQL Client/Server server that triggers the errorHErrorInfo
hErrServerInfoInformation about the server used by the Native Access that returned the error.HErrorInfo
hErrSystemCodeType of information about the error to return: Number of the associated system errorHErrorInfo
hErrSystemMessageType of information about the error to return: Message of associated system errorHErrorInfo
hErrWDDType of information about the error to return: Full name of the analysis file associated with the errorHErrorInfo
hExistingType of search: Only the assignments for which a file actually existsHListREP
hExpBreakableMode for creating the XML/JSON file: The export can be interrupted by pressing the ESC key.
If the export is interrupted, the XML 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
hExpCreationMode for creating the XML or JSON file: If the XML/JSON export file already exists, it is overwritten.HExportXML
Versions 21 and later
HExportJSON
New in version 21
HExportJSON
HExportJSON
hExpNormalMode for creating the XML/JSON file: Standard operating modeHExportXML
Versions 21 and later
HExportJSON
New in version 21
HExportJSON
HExportJSON
hExpWithoutXSLThe style sheet (".XSL" file) is not createdHExportXML
hFicSizeSize of data file in bytes (".Fic" file)HInfoFile
hFileAS400Type of file: AS400 file..Type
hFileClientServerType of file: HFSQL Client/Server file..Type
hFileHF5Type of file: Hyper File 5 file..Type
hFileMySQLType of file: MySQL file..Type
hFileNormalType of file: Standard file (HFSQL Classic)..Type
hFileOLEDBType of file: OLEDB file..Type
hFileOracleType of file: ORACLE file..Type
hFileOracleLiteType of file: ORACLE Lite file..Type
hFileOtherType of file: Other type of file..Type
Versions 15 and later
hFilePostgreSQL
New in version 15
hFilePostgreSQL
hFilePostgreSQL
Type of file: PostgreSQL file..Type
hFileProgressType of file: Progress file..Type
hFileQueryType of file: Query..Type
hFileQueryAS400Type of file: Query on an AS/400 database..Type
hFileQueryClientServerType of file: Query on a HFSQL Client/Server database..Type
hFileQueryMySQLType of file: Query on a MySQL database..Type
hFileQueryOLEDBType of file: Query on a database accessed via an OLE DB provider..Type
hFileQueryOracleType of file: Query on an Oracle database..Type
hFileQueryOracleLiteType of file: Query on an Oracle Lite database..Type
Versions 15 and later
hFileQueryPostgreSQL
New in version 15
hFileQueryPostgreSQL
hFileQueryPostgreSQL
Type of file: Query on a PostgreSQL database..Type
hFileQueryProgressType of file: Query on a Progress database..Type
Versions 16 and later
hFileQuerySQLAzure
New in version 16
hFileQuerySQLAzure
hFileQuerySQLAzure
Type of file: Query on an SQL Azure database..Type
hFileQuerySQLServerType of file: Query on an SQL Server database..Type
hFileQuerySQLServerMobileType of file: Query on an SQL Server Mobile database..Type
hFileQuerySybaseType of file: Query on a Sybase database..Type
hFileQueryXMLType of file: Query on an XML database..Type
hFileSQLType of file: SQL file..Type
Versions 16 and later
hFileSQLAzure
New in version 16
hFileSQLAzure
hFileSQLAzure
Type of file: SQL Azure file..Type
Versions 16 and later
hFileSQLite
New in version 16
hFileSQLite
hFileSQLite
Type of file: SQLite file..Type
hFileSQLServerType of file: SQL Server file..Type
hFileSQLServerMobileType of file: SQL Server Mobile file..Type
hFileSybaseType of file: Sybase file..Type
hFileTemporaryType of file: Temporary file..Type
hFileViewType of file: HFSQL view..Type
hFileXBaseType of file: xBase file..Type
hFileXMLType of file: XML file..Type
Versions 22 and later
hFindKey
New in version 22
hFindKey
hFindKey
Enable the search for keys on the HFSQL server. HSetServer
hForbiddenThe relevant rights are not granted to the user or to the groupHModifyDatabaseRights,
HModifyFileRights,
HModifyServerRights
Versions 17 and later
hForwardOnly
New in version 17
hForwardOnly
hForwardOnly
Native Accesses only:
Used to speed up the browse of data during a simple browse that does not use the following features:
  • Read the previous record.
  • Modify a record.
  • Save the position.
If one of these features is used, the result may differ from the expected one.
This constant can be used for example during a browse used to fill a memory table.
HReadLast,
HReadFirst,
HReadSeekFirst,
HReadSeekLast
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
Versions 20 and later
hftPunctuationSimple
New in version 20
hftPunctuationSimple
hftPunctuationSimple
Full-text Index item described by programming: 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 by programming: Taking into account the Unicode punctuation characters...Option property of FullTextIndex Description variables.
hFTXReindex the full-text indexesHIndex
hFtxSizeSize of full-text index file in bytes (".Ftx" file)HInfoFile
HGenericType of search: Generic searchHReadSeekLast,
HReadSeekFirst,
HSeekLast,
HSeekFirst
hGPRSFrameThe frame size is optimized for a use via GPRSHCS.FrameSize
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
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 a hORead database.HConnect
hIdenticalThe structures of the files (read in the analysis and in the physical file) must be strictly identical.HReadSeek, HSeek, HCheckStructure
hIgnoreDuplicatesIgnores the duplicate check for this operation, 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
hImpBreakableThe import can be interrupted by pressing the ESC keyHImportHF55,
HImportText,
Versions 20 and later
HImportXLS,
New in version 20
HImportXLS,
HImportXLS,
HImportXML
Versions 21 and later
HImportJSON
New in version 21
HImportJSON
HImportJSON
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
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
Versions 20 and later
hImpIgnoreFirstLine
New in version 20
hImpIgnoreFirstLine
hImpIgnoreFirstLine
Type of import: The first line of the imported file is ignored.HImportText,
Versions 20 and later
HImportXLS
New in version 20
HImportXLS
HImportXLS
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
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 the imported file (Hyper File 5.5) with no match in the import file are ignored.
HImportHF55
hImpNoDelimiterType of import: The string separators (if they exist) are part of the itemHImportText
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.
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
hImpNoSpaceType of import: The space characters found at the end of string are automatically deleted during the importHImportHF55
hImpOEM2ANSIType of import: Convert the imported strings from OEM to ANSI. This constant is available for backward compatibility.HImportText
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
hIncreasingSort performed in ascending order..SortType
hInfiniteCardinalityMaximum cardinality ("N")..MaxLinkedCardinality, ..MaxSourceCardinality
hInfoAllFull information about the server (corresponds to hInfoVi + hInfoVersion + hInfoPlatform + hInfoHardware + hInfoName + hInfoLogicalName + hInfoDate).
The different values are separated by CR characters (Carriage Return).
HInfoServer
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
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>
HInfoServer
hInfoLogicalNameName of server given in HFConf.ini or specified during the setup. This name appears in the HFSQL Control Center.HInfoServer
hInfoNameName of server (DNS)HInfoServer
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>
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
Versions 22 and later
hInfoTotalDiskSpace
New in version 22
hInfoTotalDiskSpace
hInfoTotalDiskSpace
Total capacity of server disk, expressed in MB.HInfoServer
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<
HInfoServer
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<
HInfoServer
hInfoVIVersion number of Manta.exe or Manta in LinuxHInfoServer
hInheritThe user will inherit from the value of the rights granted to the group to which he belongsHModifyDatabaseRights,
HModifyFileRights,
HModifyServerRights
hIntegrityCascadeModification/Deletion rule: Cascading modification/deletion..ModificationRule, ..DeletionRule
hIntegrityDefaultValueModification/Deletion rule: Default modification/deletion..ModificationRule, ..DeletionRule
hIntegrityForbiddenModification/Deletion rule: Modification/Deletion not allowed..ModificationRule, ..DeletionRule
hIntegrityNoneModification/Deletion rule: No integrity management..ModificationRule, ..DeletionRule
hInternetFrameThe frame size is optimized for a use via InternetHCS.FrameSize
hInternetPageSizeSize of page for using the RPC via Internet.Remote access (RPC on HFSQL)
hIntranetFrameThe frame size is optimized for a use via IntranetHCS.FrameSize
hIntranetPageSizeSize of page for using the RPC via Intranet.Remote access (RPC on HFSQL)
hInvalidRecNumConstant returned if there is no current record or if the specified file corresponds to a multi-file query.HRecNum
hItemBinaryType of item: Binary..Type
hItemBinaryMemoType of item: Binary memo..Type
hItemBinaryMemo4Type of item: Binary memo (4 bytes)..Type
hItemBooleanType of item: Boolean..Type
hItemCharacterType of item: Character..Type
Versions 20 and later
hItemCombination
New in version 20
hItemCombination
hItemCombination
Type of item: Combination..Type
hItemCurrencyType of item: Currency..Type
hItemDate6Type of item: Date..Type
hItemDate8Type of item: Date..Type
hItemDateTimeType of item: Date/Time..Type
Versions 20 and later
hItemEnumeration
New in version 20
hItemEnumeration
hItemEnumeration
Type of item: Enumeration..Type
hItemHourType of item: Time..Type
hItemIdAutoType of item: Automatic identifier (8 bytes)..Type
hItemIdAuto4Type of item: Automatic identifier (4 bytes)..Type
hItemInteger1Type of item: 1-byte integer..Type
hItemInteger2Type of item: 2-byte integer..Type
hItemInteger4Type of item: 4-byte integer..Type
hItemInteger8Type of item: 8-byte integer..Type
hItemInvalidInvalid type of item..Type
hItemNumericType of item: High-precision numeric..Type
hItemNumRecType of item: Record number..Type
hItemPictureType of item: Image..Type
hItemReal4Type of item: 4-byte real..Type
hItemReal8Type of item: 8-byte real..Type
hItemRealTurboType of item: Turbo real..Type
hItemTextType of item: Text..Type
hItemTextMemoType of item: Text memo..Type
hItemTimeLengthType of item: Duration..Type
hItemUnicodeMemoType of item: Unicode text memo..Type
hItemUnicodeTextType of item: Unicode text..Type
hItemUnsignedInteger1Type of item: Unsigned 1-byte integer..Type
hItemUnsignedInteger2Type of item: Unsigned 2-byte integer..Type
hItemUnsignedInteger4Type of item: Unsigned 4-byte integer..Type
hItemUnsignedInteger8Type of item: Unsigned 4-byte integer..Type
hJNLBackupPathPath of the directory containing the backups of the logsHSetServer
hJNLPathPath of the directory containing all the logs of the different HFSQL Client/Server applicationsHSetServer
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 time-out (in seconds) for the server when checking the presence of client. If the client is not found at the end of this time-out, the client is automatically disconnected. HSetServer
hKeepFilterThe filter implemented 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, lack of performance may occur on the huge files.
HChangeKey, HLast, HReadLast, HReadFirst, HReadSeekLast, HReadSeekFirst, HReadSeek, HFirst, HSeek, HSeekLast, HSeekFirst
hKeepTRSStores the transaction files during the deletionHDeleteDatabase,
HDeleteFile
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, ..LanguageDescribed, H.LanguageCreationUnicode
hLanguageCreationUsed to find out whether the language used to perform the comparisons and the sort corresponds to "Defined at creation"...Language, ..LanguageDescribed
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, ..LanguageDescribed, H.LanguageCreationUnicode
hlbActiveEnable or disable the load balancingHSetServer
hlbClientCallsValue modifying the coefficient applied to the counter for client callsHSetServer
hlbDiskValue modifying the coefficient applied to the counter for the bytes read or written on disk by the serverHSetServer
hlbDiskAccessValue modifying the coefficient applied to the counter for the number of disk accesses.HSetServer
hlbMaxTimeoutValue modifying the maximum time-out for a server requestHSetServer
hlbReceivedValue modifying the coefficient applied to the counter for the bytes received by the serverHSetServer
hlbSentValue modifying the coefficient applied to the counter for the bytes sent by the serverHSetServer
hLimitParsingLimits the file browse: The browse will stop as soon as the last sought value is found. The current record will correspond to this last record found.
HFound will be set to False and HOut will be set to True.
This constant is used to optimize the search speed in client/server mode.
HReadSeek, HReadSeekLast, HReadSeekFirst, HSeek, HSeekLast, HSeekFirst
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
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
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
hLogIdentificationConfigures the file to re-create: Re-creates the "JournalIdentification.fic" file.HLogRecreate
hLogJNLFileConfigures the file to re-create: Only <File Name>JNL.FIC is recreated.HLogRecreate
hLogLevelDefines the elements that must be found in the log fileHSetServer
hLogNoFormat of log process: No logLogMethod
hLogOperationConfigures the file to re-create: Re-creates the "JournalOpération.fic" file.HLogRecreate
hLogPathPath of the directory containing the log filesHSetServer
hLogReadingWritingFormat of log process: Log the read and write operations performed in the file..LogMethod
hLogUserConfigures the file to re-create: Re-creates 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
hLogWritingFormat of log process: Log the write operations performed in the file..LogMethod
Versions 20 and later
hlpBackup
New in version 20
hlpBackup
hlpBackup
Type of scheduling to list: Scheduling of backups.
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
hlpMaterializedView
New in version 20
hlpMaterializedView
hlpMaterializedView
Type of scheduling to list: Tasks for refreshing the materialized views.
Versions 20 and later
hlpOptimization
New in version 20
hlpOptimization
hlpOptimization
Type of scheduling to list: Tasks for optimizing files (reindexing, statistical calculation).
Versions 22 and later
hlpReplication
New in version 22
hlpReplication
hlpReplication
Type of operation performed on the server: replication of servers.
Versions 22 and later
hServerOperation type
New in version 22
hServerOperation type
hServerOperation type
Versions 20 and later
hlpTask
New in version 20
hlpTask
hlpTask
Type of scheduling to list: Scheduled tasks that run a stored procedure.
hLstAllLists all the keys, all the files, all the items or all the connectionsHListKey, HListFile, HListItem, HListConnection,
HListStoredElement
hLstCompositeKeyLists the composite key items onlyHListKey, HListItem
Versions 22 and later
hLstDatabaseSize
New in version 22
hLstDatabaseSize
hLstDatabaseSize
List of connection databases as well as their size. HListDatabase
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
hLstItemLists the non-key and non-memo itemsHListItem
hLstKeyLists the key itemsHListKey, HListItem
hLstLogicalOrderLists the items or the keys according to the logical order of itemsHListKey, HListItem
Versions 20 and later
hLstMaterializedView
New in version 20
hLstMaterializedView
hLstMaterializedView
Lists the materialized views found on a HFSQL server.HListFile
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
hLstOpenedStores the opened connections onlyHListConnection
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
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.
hLstSetLists the sets of procedures found on a serverHListStoredElement
hLstSortedSorts the list of keys, files, items or connection in ascending orderHListKey, HListFile, HListItem, HListConnection
hLstStoredProcedureLists the stored procedures of a connection via native access or OLE DBHListFile,
HListStoredElement
hLstSystemTableList of system tables for a connection via native access or OLE DBHListFile
hLstTableList of user tables for a connection via native access or OLE DBHListFile
hLstView
  • List the views of a connection via native access or OLE DB.
  • Versions 20 and later
    Lists the SQL views found on a HFSQL server.
    New in version 20
    Lists the SQL views found on a HFSQL server.
    Lists the SQL views found on a HFSQL server.
HListFile
hMasterReplicaReplication mode: The data file is a master replica (HCreateMasterReplica was used to create the master replica)..Replication
hMaxActivityStatisticsSizeMaximum size in megabytes (MB) of files for activity statisticsHSetServer
hMaxLogSizeMaximum size in megabytes (MB) of log filesHSetServer
hMaxValDefines an upper bound for a filterHBuildKeyValue,
HFilter,
HFilterStartsWith,
HFilterIncludedBetween
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
hMemoWavType of file used for the memo: sound fileHLinkMemo
hMemoYesThe text memos are read whenever the record is read.
Read the binary memos when accessing the item.
HSetMemo
hMessageConfigure the information messageHOnServerCall
hMinValDefines a lower bound for a filterHBuildKeyValue,
HFilter,
HFilterStartsWith,
HFilterIncludedBetween
Versions 20 and later
hMmoCompact
New in version 20
hMmoCompact
hMmoCompact
Compression and defragmentation of "Mmo" files.HIndex
hMmoSizeSize of memo file in bytes (".Mmo" file)HInfoFile
hMode2GBIndicates whether the system files support more than 2 GBHSetServer
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
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
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
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
hNativeAccessAS400Provider that will be used for the connection: Native AS/400 access (optional module of WINDEV)HConnect, HDeclareExternal,
HDescribeConnection, HListFile,
HOpenConnection,
..Provider, ..CtOLEDBProvider, ..CtDescribedOLEDBProvider
hNativeAccessDB2OLE DB provider that will be used for the connection: Native DB2 access (optional module of WINDEV)HConnect, HDeclareExternal,
HDescribeConnection, HListFile,
HOpenConnection,
..Provider, ..CtOLEDBProvider, ..CtDescribedOLEDBProvider
hNativeAccessInformixOLE DB provider that will be used for the connection: Native Informix access (optional module of WINDEV)HConnect, HDeclareExternal,
HDescribeConnection, HListFile,
HOpenConnection,
..Provider, ..CtOLEDBProvider, ..CtDescribedOLEDBProvider
Versions 20 and later
hNativeAccessMariaDB
New in version 20
hNativeAccessMariaDB
hNativeAccessMariaDB
OLE DB provider that will be used for the connection: Native MariaDB Access (optional module of WINDEV/WEBDEV)HConnect, HDeclareExternal,
HDescribeConnection, HListFile,
HOpenConnection,
..Provider, ..CtOLEDBProvider, ..CtDescribedOLEDBProvider
hNativeAccessMySQLOLE DB provider that will be used for the connection: Native MySQL AccessHConnect, HDeclareExternal,
HDescribeConnection, HListFile,
HOpenConnection,
..Provider, ..CtOLEDBProvider, ..CtDescribedOLEDBProvider
hNativeAccessOracleOLE DB provider that will be used for the connection: Native Oracle access (optional module of WINDEV)HConnect, HDeclareExternal,
HDescribeConnection, HListFile,
HOpenConnection,
..Provider, ..CtOLEDBProvider, ..CtDescribedOLEDBProvider
hNativeAccessOracleLiteProvider that will be used for the connection: Native Oracle Access (optional module of WINDEV Mobile)HConnect, HDeclareExternal,
HDescribeConnection, HListFile,
HOpenConnection,
..Provider, ..CtOLEDBProvider, ..CtDescribedOLEDBProvider
hNativeAccessPostgreSQLOLE DB provider that will be used for the connection: Native PostgreSQL AccessHConnect, HDeclareExternal,
HDescribeConnection, HListFile,
HOpenConnection,
..Provider, ..CtOLEDBProvider, ..CtDescribedOLEDBProvider
hNativeAccessProgressOLE DB provider that will be used for the connection: Native Progress access (optional module of WINDEV)HConnect, HDeclareExternal,
HDescribeConnection, HListFile,
HOpenConnection,
..Provider, ..CtOLEDBProvider, ..CtDescribedOLEDBProvider
Versions 16 and later
hNativeAccessSQLAzure
New in version 16
hNativeAccessSQLAzure
hNativeAccessSQLAzure
OLE DB provider that will be used for the connection: Native SQL Azure accessHConnect, HDeclareExternal,
HDescribeConnection, HListFile,
HOpenConnection,
..Provider, ..CtOLEDBProvider, ..CtDescribedOLEDBProvider
Versions 15 and later
hNativeAccessSQLite
New in version 15
hNativeAccessSQLite
hNativeAccessSQLite
OLE DB provider that will be used for the connection: Native Access to a SQLite databaseHConnect, HDeclareExternal,
HDescribeConnection, HListFile,
HOpenConnection,
..Provider, ..CtOLEDBProvider, ..CtDescribedOLEDBProvider
hNativeAccessSQLServerOLE DB provider that will be used for the connection: Native SQL Server access (optional module of WINDEV)HConnect, HDeclareExternal,
HDescribeConnection, HListFile,
HOpenConnection,
..Provider, ..CtOLEDBProvider, ..CtDescribedOLEDBProvider
hNativeAccessSQLServerMobileProvider that will be used for the connection: Native SQL Server Mobile Access (optional module of WINDEV Mobile)HConnect, HDeclareExternal,
HDescribeConnection, HListFile,
HOpenConnection,
..Provider, ..CtOLEDBProvider, ..CtDescribedOLEDBProvider
hNativeAccessSybaseOLE DB provider that will be used for the connection: Native Sybase access (optional module of WINDEV)HConnect, HDeclareExternal,
HDescribeConnection, HListFile,
HOpenConnection,
..Provider, ..CtOLEDBProvider, ..CtDescribedOLEDBProvider
hNativeAccessXBaseOLE DB provider that will be used for the connection: Native xBase accessHConnect, HDeclareExternal,
HDescribeConnection, HListFile,
HOpenConnection,
..Provider, ..CtOLEDBProvider, ..CtDescribedOLEDBProvider
hNativeAccessXMLProvider that will be used for the connection: Native XML Access (supplied with WINDEV/WEBDEV)HConnect, HDeclareExternal,
HDescribeConnection, HListFile,
HOpenConnection,
..Provider, ..CtOLEDBProvider, ..CtDescribedOLEDBProvider
hNdxCacheSizeMaximum size in megabytes (MB) of index cacheHSetServer
hNdxCompactRe-index operation with compressionHIndex
hNdxDeleteRe-index while deleting the damaged recordsHIndex
hNdxMinimalRe-index operation while ignoring the corrupted keysHIndex
hNdxNormalStandard re-index operationHIndex
hNdxNoStatRe-index without statistical calculationHIndex
hNdxSilentConfigure the re-index operation: No display while re-indexingHIndex
hNdxSizeSize of index file in bytes (".Ndx" file)HInfoFile
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
hNoErrorNo error occurredHError
Versions 21 and later
hNoHourglass
New in version 21
hNoHourglass
hNoHourglass
When reading the query result, this read operation may be locked and a hourglass appears by default. This constant is used not to display the hourglass in this case. HExecuteQuery, HExecuteSQLQuery
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
Versions 15 and later
hNone
New in version 15
hNone
hNone
Used to disable the simulation of a specific network.HSimulateNetwork
hNoRefreshThe table or query content will not be refreshedHLast, HReadLast, HReadFirst, HFirst
hNotAKeyCharacteristics of an item: Non-key item..KeyType
hNotesProperty of a database found on a HFSQL server: Database description or any other information associated with the database by HModifyDatabaseProperty.HInfoDatabaseProperty, HInfoFileProperty, HInfoServerProperty, HModifyDatabaseProperty, HModifyFileProperty, HModifyServerProperty
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
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
hNotLockingNumber of records retrieved in the view or query without waiting for the view or query to be entirely filled. To find out whether the execution of the view or query is completed, use ..ExecutionCompleted.
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 accesses.
hNbRec
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
hNotSortedSort direction: Item not sorted..SortType
hODBCOLE DB provider that will be used for the connection: OLE DB provider for ODBC. Used to access an ODBC source declared in the ODBC data sources of Windows..CtOLEDBProvider, ..CtDescribedOLEDBProvider,
HConnect, HDeclareExternal, HListFile, HOpenConnection, SQLConnect
hOledbAccess2000OLE DB provider that will be used for the connection: OLE DB provider for Access 2000..CtOLEDBProvider, ..CtDescribedOLEDBProvider,
HConnect, HDeclareExternal, HListFile, HOpenConnection, SQLConnect
hOledbAccess2007OLE DB provider that will be used for the connection: OLE DB provider for Access 2007..CtOLEDBProvider, ..CtDescribedOLEDBProvider,
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 2010..CtOLEDBProvider, ..CtDescribedOLEDBProvider,
HConnect, HDeclareExternal, HListFile, HOpenConnection, SQLConnect
hOledbAccess97OLE DB provider that will be used for the connection: OLE DB provider for Access 97..CtOLEDBProvider, ..CtDescribedOLEDBProvider,
HConnect, HDeclareExternal, HListFile, HOpenConnection, SQLConnect
hOledbDBase5OLE DB provider that will be used for the connection: OLE DB provider for dBase 5..CtOLEDBProvider, ..CtDescribedOLEDBProvider,
HConnect, HDeclareExternal, HListFile, HOpenConnection, SQLConnect
hOledbExcel2000OLE DB provider that will be used for the connection: OLE DB provider for Excel 2000..CtOLEDBProvider, ..CtDescribedOLEDBProvider,
HConnect, HDeclareExternal, HListFile, HOpenConnection, SQLConnect
hOledbExcel2007OLE DB provider that will be used for the connection: OLE DB provider for Excel 2007..CtOLEDBProvider, ..CtDescribedOLEDBProvider,
HConnect, HDeclareExternal, HListFile, HOpenConnection, SQLConnect
hOledbExcel97OLE DB provider that will be used for the connection: OLE DB provider for Excel 97..CtOLEDBProvider, ..CtDescribedOLEDBProvider,
HConnect, HDeclareExternal, HListFile, HOpenConnection, SQLConnect
hOledbLotus4OLE DB provider that will be used for the connection: OLE DB provider for Lotus 4..CtOLEDBProvider, ..CtDescribedOLEDBProvider,
HConnect, HDeclareExternal, HListFile, HOpenConnection, SQLConnect
hOledbOracleOLE DB provider that will be used for the connection: OLE DB provider for Oracle..CtOLEDBProvider, ..CtDescribedOLEDBProvider,
HConnect, HDeclareExternal, HListFile, HOpenConnection, SQLConnect
hOledbSQLServerOLE DB provider that will be used for the connection: OLE DB provider for SQL Server..CtOLEDBProvider, ..CtDescribedOLEDBProvider,
HConnect, HDeclareExternal, HListFile, HOpenConnection, SQLConnect
hOnDeleteIntegrity rule applied during a deletionHSetIntegrity
hOnUpdateIntegrity rule applied during a modificationHSetIntegrity
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. The modifications performed by the other users are visible (but not the additions).HDescribeConnection,
HOpenConnection
hOptimisticCursorThe record is locked when it is updatedHDescribeConnection,
HOpenConnection
Versions 15 and later
hOptIndex
New in version 15
hOptIndex
hOptIndex
Optimization options: Provokes the reindexing operation on the data files. A hot reindexing 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
hOReadFile accessible in read-only..CtAccess, ..CtDescribedAccess,
HConnect, HOpen
hOReadWriteFile accessible in read/write..CtAccess, ..CtDescribedAccess,
HConnect, HOpen
hOwnerProperty of a database found on a HFSQL server: Owner of database.HInfoDatabaseProperty, HInfoFileProperty, HModifyDatabaseProperty, HModifyFileProperty
hPackNoCompression mode: No compression..MmoPackMethod
hPackZLWCompression mode: Compression based on the Ziw-Lempel algorithm, Welch implementation...MmoPackMethod
hPageSizeSize of a block of caches. This block of caches will be used when browsing a file. A large block of caches improves the browse and increases the transfers via network and the memory consumption.HSetCache
hPessimisticCursorThe record is locked as soon as it becomes in edit to be modified.HDescribeConnection,
HOpenConnection
hPrecisionHighPosition with high precisionHGetCurrentPosition, HSetPosition
hPrecisionLowPosition with low precisionHGetCurrentPosition, HSetPosition
hPrecisionMediumPosition with medium precisionHGetCurrentPosition, HSetPosition
hQueryBreakableThe query initialization can be interrupted with the ESC keyHExecuteQuery, HExecuteSQLQuery
hQueryDefaultThe query is initialized without interruptionHExecuteQuery, HExecuteSQLQuery
hQueryWithoutCorrectionNative access 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 type of connection (Oracle, SQL Server, ...)
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 19 and later
hReadCommitted
New in version 19
hReadCommitted
hReadCommitted
Isolation level of transaction: only the finalized transactions are visible by the other users.
Versions 19 and later
HTransactionIsolation
New in version 19
HTransactionIsolation
HTransactionIsolation
hReadOnlyCursorThe set of records cannot be modified.HDescribeConnection,
HOpenConnection
Versions 19 and later
hReadUncommitted
New in version 19
hReadUncommitted
hReadUncommitted
Isolation level of transaction: the non-finalized transactions are visible by the other users.
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
hRecFileRecord to read: Value of the item currently saved in the data fileHErrorModification, HErrorStatusModification
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
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
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
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
hReplicatedReplication mode: The data file is configured to be replicated...Replication
hRightsAllList of all the rightsHInfoDatabaseRights,
HInfoFileRights,
HInfoServerRights
hRightsAutoModifRights to perform the automatic modification of the data files on a fileHInfoDatabaseRights,
HInfoFileRights,
HModifyDatabaseRights,
HModifyFileRights
hRightsBackupRights to save the data filesHInfoDatabaseRights,
HInfoServerRights,
HModifyDatabaseRights,
HModifyServerRights
hRightsChangeLinkRights to modify the integrity rules on a data file.HInfoDatabaseRights,
HInfoFileRights,
HModifyDatabaseRights,
HModifyFileRights
hRightsChangeOwnerRights to modify the owner of an elementHInfoDatabaseRights,
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
hRightsChangeRightsRights to change the rights.HInfoDatabaseRights,
HInfoFileRights,
HInfoServerRights,
HModifyDatabaseRights,
HModifyFileRights,
HModifyServerRights
hRightsConnectionRights to connect to a server (encrypted or unencrypted connection)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
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
hRightsDisconnectClientRights to disconnect the client computers.HInfoServerRights,
HModifyServerRights
hRightsEncryptedConnectionRights to connect to a server (encrypted connection only)HInfoDatabaseRights,
HModifyDatabaseRights
hRightsInsertRights to add new records into a data file.HInfoDatabaseRights,
HInfoFileRights,
HModifyDatabaseRights,
HModifyFileRights
hRightsLockRights to lock the data files or the records of a data file.HInfoDatabaseRights,
HInfoFileRights,
HModifyDatabaseRights,
HModifyFileRights
hRightsMaintenanceRights to start a re-index operation or to perform statistical calculations on a data fileHInfoDatabaseRights,
HInfoFileRights,
HModifyDatabaseRights,
HModifyFileRights
hRightsManageDuplicateRights to enable and disable the management of duplicates.HInfoDatabaseRights,
HInfoFileRights,
HModifyDatabaseRights,
HModifyFileRights
hRightsManageIntegrityRights to enable and disable the management of integrity.HInfoDatabaseRights,
HModifyDatabaseRights
hRightsManageProcedureRights to add, modify and delete the stored procedures.HInfoDatabaseRights,
HModifyDatabaseRights
hRightsManageServerRights to use HSetServerHInfoServerRights,
HModifyServerRights
hRightsManageTaskRights to manage the scheduled tasks.HInfoServerRights,
HModifyServerRights
hRightsManageTriggerRights to manage the server triggers (addition, activation, deletion)HInfoDatabaseRights,
HModifyDatabaseRights
hRightsManageUserRights to delete and add users or groupsHInfoServerRights,
HModifyServerRights
hRightsNoDatabaseAccessRights to forbid (or not) the access to a database (HNoDatabaseAccess and HEndNoDatabaseAccess)HInfoDatabaseRights,
HModifyDatabaseRights
hRightsPriorityRights to modify the priority of a client applicationHInfoServerRights,
HModifyServerRights
hRightsReadRights to read the records of a data fileHInfoDatabaseRights,
HInfoFileRights,
HModifyDatabaseRights,
HModifyFileRights
hRightsReadLogStatRights to see the activity statistics and the logs of the server.HInfoServerRights,
HModifyServerRights
hRightsRunProcedureRights to run the stored procedures.HInfoDatabaseRights,
HModifyDatabaseRights
hRightsSeeUserRights to view the characteristics of a group or user.HInfoServerRights,
HModifyServerRights
hRightsSendMessageToClientRights to send messages to the client computers.HInfoServerRights,
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
hRightsStopServerRights to stop a server (HStopServer)HInfoServerRights,
HModifyServerRights
hRightsUpdateRights to modify the records of a data fileHInfoDatabaseRights,
HInfoFileRights,
HModifyDatabaseRights,
HModifyFileRights
hRPDefaultConfigure the restore operation: Position freed. The stored position is restoredHRestorePosition
hRPFilterConfigure the restore operation: Restore the filter implemented during the call to HSavePositionHRestorePosition
hRPHF5Configure the restore operation: If the stored position was deleted or modified, this position is restoredHRestorePosition
hRPKeepConfigure the restore operation: Position not freedHRestorePosition
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
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
hSaveItemsSaves the values of items in memory when using HSavePosition. These values will be restored during the call to HRestorePosition.HSavePosition
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 19 and later
hSecondaryThread
New in version 19
hSecondaryThread
hSecondaryThread
Option for running the procedure: the procedure is run in a secondary thread.HOnServerCall
hServerCursorCursor managed by the database. This cursor can easily apply the changes performed by the other users to the data.HDescribeConnection,
HOpenConnection
hServerPortNetwork port usedHSetServer
hSetIdAutoMode for calculating the automatic identifier: Value of the identifier equals to the one stored during the write operationHAdd, HWrite, HModify
hSetIdAutoMode for calculating the automatic identifier: Value of the identifier equals to the one stored during the additionHAdd, HWrite, HModify
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 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
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
hStartedServer startedHServerStatus
hStateActiveStatus of the record/Type of record taken into account: Active recordHState, hNbRec, HErrorStatusModification
hStateAllType of record: Total number of records in the data filehNbRec
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
hStateInvalidRecord status not found (error)HState, HErrorStatusModification
hStaticCursorRetrieves a copy of all the query records in memory (consumes a lot of memory). All types of moves are allowed.HDescribeConnection,
HOpenConnection
hStoppedServer stoppedHServerStatus
hStructureConfigure the file management: New empty file created from the file descriptionHRegenerateFile
hSubErrFirstType of error returned: Number of the first sub-errorHError
hSubErrLastType of error returned: Number of the last sub-errorHError
hSubErrNextType of error returned: Number of the previous sub-errorHError
hSubErrPreviousType of error returned: Number of the previous sub-errorHError
hSubscriberReplicaReplication mode: The data file is a subscriber replica (HCreateSubscriberReplica was used to create the subscriber replica)..Replication
Versions 22 and later
hTelemetryEnable
New in version 22
hTelemetryEnable
hTelemetryEnable
Configure the sending of data via the telemetry for the HFSQL server. HSetServer
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 reindexing large data files for example).HSetServer
hTotalSizeTotal file size in bytes (added size of data file, memo file and index file).HInfoFile
hTriggerAfterIndicates the type of trigger: The procedure is run after the HFSQL functionHActivateTrigger, HDeactivateTrigger, HDeleteTrigger, HDescribeTrigger
hTriggerBeforeIndicates the type of trigger: The procedure is run before the HFSQL functionHActivateTrigger, HDeactivateTrigger, HDeleteTrigger, HDescribeTrigger
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
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
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
hUnicodeUsed to retrieve the record value in Unicode format.HRetrieveRecord
hUNICODEFormatFormat of data: UNICODE format..Format
hUniqueKeyCharacteristics of an item: Unique key..KeyType
hViewAddCreate a view with addition: Stores the view content during the next call to HExecuteViewHCreateView, HMergeView
hViewBreakableThe view creation can be interrupted by pressing the ESC keyHCreateView
hViewDefaultDefault creation of viewHCreateView, HMergeView
hViewDistinctThe view is created without duplicates according to the sort keyHCreateView, HMergeView
hViewExclusiveOptimizes the creation time of view by locking the entire source fileHCreateView, HMergeView
hViewIntersectionMerge views with intersection: Common rows between the two specified viewsHMergeView
hViewJoinJoin between the first view and the second view.HMergeView
hViewLockingThe records read in the file and included in the view are lockedHCreateView, HMergeView
hViewPostponedThe view is created but it will be run later by HExecuteViewHCreateView, 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
hWifiFrameThe frame size is optimized for a use via WifiHCS.FrameSize
Versions 19 and later
hWindowsDiskCacheSize
New in version 19
hWindowsDiskCacheSize
hWindowsDiskCacheSize
Mode for managing the size of Windows disk cache.HSetServer
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 a HFSQL view
  • the following operations are not allowed: search on the query result, query on query, view on query, query on view.
  • the search items specified when browsing 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 a 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 search items specified when browsing the result are taken into account.
  • the magnifier is available for the 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, ...), the transaction is canceled and the data files are restored to their previous status (before the query execution).
Note: The query execution may be slowed down.
HExecuteQuery, HExecuteSQLQuery
hWriteDefaultAddition not affecting the current browse/Identifier re-used or calculated for the recordHAdd, HWrite, HModify
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 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 is used to find out the result of refresh performed on the materialized view.
Versions 20 and later
HRefreshView
New in version 20
HRefreshView
HRefreshView
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
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 code line:
IF NOT <HFSQL function> THEN ReturnToCapture()
HOnError
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 code line:
IF NOT <HFSQL function> THEN EndProgram()
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
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
Minimum required version
  • Version 9
This page is also available for…
Comments
Click [Add] to post a comment