Associates the data directory specified in the analysis with a directory found on disk. Once HSubstDir
has been run, all the data files associated with the directory specified in the analysis will be handled in the indicated directory.
: The data files must be closed beforehand (HClose
To modify the path of a single data file, use HChangeDir
Remark: From version 19, HFSQL is the new name of HyperFileSQL.
<Result> = HSubstDir(<Directory of files specified in analysis> , <Physical directory of files on disk>)
This parameter is always equal to True. If an error occurs, the next function for accessing the data file will return False. For example, if the specified physical directory does not exist, a directory error will occur during the first access to the data file.
<Directory of files specified in analysis>: Character string with quotes
Name of the directory specified during the description of the data file.
If this parameter is equal to "?" or to ".", the current directory of the application is taken into account (directory returned by fCurrentDir
<Physical directory of files on disk>: Character string with quotes
New name of the directory (up to 260 characters). A UNC path can be used.
HSubstDir is ignored if the specified directory contains data files in a format other than HFSQL.
If this parameter corresponds to:
- an empty string (""): the substitution is canceled: the data directory described in the analysis is taken into account.
- "?" or ".": the physical data directory corresponds to the current directory.
Multiple directory substitutions
HSubstDir can be called several times with different parameters. When the physical directory is redefined several times for the same logical directory (described in the analysis), the last specified physical directory replaces all the other ones.
is used to associate a directory with a data file. To substitute a directory for another one, use HSubstDir
Caution: the change of directory performed by HSubstDir
applies to the directory defined by HChangeDir
. For example:
HCréation(Stat) //File created in C:\New\JanStats
- If the management of ".REP" is enabled (HSetREP), the modification of the path is saved in the ".REP" file (see management of .REP).
- The new path is stored when the data file is closed.
- This function cannot be used during a remote access. See RPC on HFSQL (Remote access) for more details.
- The number of substitutions is unlimited.
Business / UI classification: Business Logic