HSubstDir (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

Help / WLanguage / Managing databases / HFSQL / HFSQL functions

Multiple directory substitutions
Substituting directories
Miscellaneous

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

HSubstDir (Function)

In french: HSubstRep

Available only with these kinds of connection

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.

Caution: The data files must be closed beforehand (HClose).

To modify the path of a single data file, use HChangeDir.

Remark: In Client/Server mode, use HChangeDir.

Example

See additional examples

// Change the directory for the files defined in
// a specific directory in the analysis
HSubstDir("C:\File", "D:\File")
// Open/Create the files in the new directory
HCreationIfNotFound("*")

IF HSubstDir(".","C:\ACCOUNTING\YEAR2012") = True THEN
	Info("You are going to work on the files found in the directory: C:\ACCOUNTING\YEAR2012")
ELSE
	Error(HError)
END

Syntax

<Result> = HSubstDir(<Directory of files specified in analysis> , <Physical directory of files on disk>)

<Result>: Boolean

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

Name of the directory specified during the description of the data file.
If this parameter is equal to "?" or ".", the current directory of the application is taken into account (directory returned by fCurrentDir).

<Physical directory of files on disk>: Character string

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.

Remarks

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.

Substituting directories

HChangeDir is used to associate a directory with a data file. To replace a directory with another one, use HSubstDir.

Caution: the change of directory performed by HSubstDir applies to the directory defined by HChangeDir. For example:

HSubstDir("C:\Statistics\January", "C:\New\JanStats")
HChangeDir(Stat, "C:\Statistics\January")
HCréation(Stat) //File created in C:\New\JanStats

Miscellaneous

If the management of ".REP" is enabled (HSetREP), the modification of the path is saved in the ".REP" file (see management of .REP files).
The new path is stored when the data file is closed.
The number of substitutions is unlimited.

Business / UI classification: Business Logic

Component: wd300hf.dll