HClose (Function)

Closes a data file or all the data files opened by the current user: all the corresponding physical data files are closed for the current user. For the HFSQL data files, the following files are closed:

the data file (.FIC),
the index file (.NDX) if it exists,
the memo file (.MMO) if it exists.
the full-text index file (.FTX) if it exists.

If the data file or some of its records were locked, they are unlocked.

Once the data file is closed, the reassignments performed by HChangeName, HChangeDir and HSubstDir are kept.

If a query was run on the data file, HCancelDeclaration must be called on the query in order for the closing to be effective.

The standby mode can have harmful effects on the data files. We recommend that you close them when the computer might go into standby.

Versions 15 and later

This function is now available for the Android applications.

New in version 15

This function is now available for the Android applications.

Versions 17 and later

This function is now available for the iPhone/iPad applications.

New in version 17

This function is now available for the iPhone/iPad applications.

Versions 18 and later

This function is now available in Android Widget mode.

This function is now available in Windows Store apps mode.

New in version 18

This function is now available in Android Widget mode.

This function is now available in Windows Store apps mode.

This function is now available in Android Widget mode.

This function is now available in Windows Store apps mode.

Versions 21 and later

This function is now available in Universal Windows 10 App mode.

New in version 21

This function is now available in Universal Windows 10 App mode.

Note: From version 19, HFSQL is the new name of HyperFileSQL.

Example

// Close the "Supplier" file
HClose(Supplier)

IF NOT HClose("") THEN
Error("Problem while closing the files")
END

Syntax

<Result> = HClose([<File Name>])

<Result>: Boolean

True if the data file was closed,
False otherwise. HError returns more details about the problem.

<File Name>: Optional character string (with or without quotes)

Name of data file to close. If this name is not specified, HClose closes the last data file used by the last function for HFSQL management (starting with the letter H).
If this parameter is equal to "*" or if it corresponds to an empty string (""), all the opened data files will be closed.
This parameter can also correspond to the name of a group of files (or custom-folder) defined in the analysis.

Remarks

Closing the tables and the connection

When all the tables that use the same connection (tables opened on the same database with the same connection parameters) are closed, the connection is automatically closed.

To close a connection, use HCloseConnection.

Closing the data file and filters

The filters defined on the data file with HFilter are automatically deleted when the file is closed by HClose.

Component : wd240hf.dll