HChangeDir (Function)

WINDEV, WEBDEV AND WINDEV MOBILE
ONLINE HELP

Version:

Home | Sign in | English

Help

WLanguage

Management of databases

Multiple changes of directory

Changing the name of data file

Substituting directories

Various

See also

HChangeDir (Function)

In french: HChangeRep

Not available with this kind of connection

Modifies the access path to a data file (which means the directory where the data file will be used). If the data file is opened when using HChangeDir, the data file is automatically closed.
Reminder: By default, the physical file corresponding to the data file described in the analysis is handled in the directory specified in the analysis.
Changes the name of database associated with a table. In this case, the database name specified in the connection properties of table (in the data model editor) is ignored.
To modify the connection parameters of a data file not in HFSQL format, we recommend that you use HDescribeConnection and HChangeConnection.

This function operates for the connections to a HFSQL database only.

Versions 17 and later

This function is now available for iPhone/iPad applications.

New in version 17

This function is now available for 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.

This function is now available for the Android applications (for the HFSQL data files).

This function is now available for the Java applications.

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 for the Android applications (for the HFSQL data files).

This function is now available for the Java applications.

This function is now available in Android Widget mode.

This function is now available in Windows Store apps mode.

This function is now available for the Android applications (for the HFSQL data files).

This function is now available for the Java applications.

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

// Create the HFSQL Classic Stat file in
// "C:\Statistics\January"
HChangeDir(Stat, "C:\Statistics\January")
HCreation(Stat)

// Create the HFSQL Client/Server Stat file in "\January\"
// This directory is found at the root
// of database folder (HFSQL Client/Server connection)
HChangeDir(Stat, ".\January\")

// File associated with a connection by OLE DB.
// Replace the database that will be used for the "Customers" table
HChangeDir(Customers, "C:\Temp\MyTestDB.mdb")
HCreation(Customers)
// The "Customers" table was created in the "c:\temp\mytestdb.mdb" database
// The "Customers" table of database ("c:\temp\myinitialdb.mdb") was not modified

Syntax

With HFSQL data files Hide the details

<Result> = HChangeDir(<Logical file name> , <New file path>)

<Result>: Boolean

True if the operation was performed,
False if a problem occurred. HError is used to identify the error.

<Logical file name>: Character string (with or without quotes)

Logical name of HFSQL data file (defined in the analysis).
If this parameter is equal to "*", the change of directory will be applied to all known data files (described in the analysis).
This parameter can also correspond to the name of a group of data files (or custom-folder) defined in the analysis.

<New file path>: Character string (with quotes)

Access path to data file (up to 260 characters). This path can contain the name of drive and directories, or it can be a relative path.
If the path is a relative path, the "." (or "?") character is used to specify the current directory and the ".." character is used to specify the parent directory.
If this parameter corresponds to an empty string (""), the data file will be handled in the directory specified in the analysis.
No relative path can be used.
The access path to the data file must be relative to the database found on the server. You cannot specify a path outside the database. A WLanguage error occurs when attempting to access data files outside the database. For example:
Valid path:

HChangeDir(FileName, "SUBDIR")

OR

HChangeDir(FileName, ".\SUBDIR")

Invalid path:

HChangeDir(FileName, "C:\DB\SUBDIR")

The new path will be automatically created if it is valid and if it does not exist.
Versions 17 and later
This parameter can correspond to a full path or to a relative path in relation to the current directory (returned by fCurrentDir). This parameter is case sensitive.
Reminder: On iPhone/iPad, an application has the rights to write into its setup directory or into one of its subdirectories.
New in version 17
This parameter can correspond to a full path or to a relative path in relation to the current directory (returned by fCurrentDir). This parameter is case sensitive.
Reminder: On iPhone/iPad, an application has the rights to write into its setup directory or into one of its subdirectories.
This parameter can correspond to a full path or to a relative path in relation to the current directory (returned by fCurrentDir). This parameter is case sensitive.
Reminder: On iPhone/iPad, an application has the rights to write into its setup directory or into one of its subdirectories.

With HFSQL data files Hide the details

<Result> = HChangeDir(<Logical file name> , <New file path>)

<Result>: Boolean

True if the operation was performed,
False if a problem occurred. HError is used to identify the error.

<Logical file name>: Character string (with or without quotes)

Logical name of HFSQL data file (defined in the analysis).
If this parameter is equal to "*", the change of directory will be applied to all known data files (described in the analysis).
This parameter can also correspond to the name of a group of files (or custom-folder) defined in the analysis (not available in Android and Android Widget).

<New file path>: Character string (with quotes)

Access path to data file (up to 260 characters). This path can contain the name of drive and directories, or it can be a relative path.
If the path is a relative path, the "." (or "?") character is used to specify the current directory and the ".." character is used to specify the parent directory.
If this parameter corresponds to an empty string (""), the data file will be handled in the directory specified in the analysis.
No relative path can be used.
The access path to the data file must be relative to the database found on the server. You cannot specify a path outside the database. A WLanguage error occurs when attempting to access data files outside the database. For example:
Valid path:

HChangeDir(FileName, "SUBDIR")

OR

HChangeDir(FileName, ".\SUBDIR")

Invalid path:

HChangeDir(FileName, "C:\DB\SUBDIR")

The new path will be automatically created if it is valid and if it does not exist.
Versions 17 and later
This parameter can correspond to a full path or to a relative path in relation to the current directory (returned by fCurrentDir). This parameter is case sensitive.
Reminder: On iPhone/iPad, an application has the rights to write into its setup directory or into one of its subdirectories.
New in version 17
This parameter can correspond to a full path or to a relative path in relation to the current directory (returned by fCurrentDir). This parameter is case sensitive.
Reminder: On iPhone/iPad, an application has the rights to write into its setup directory or into one of its subdirectories.
This parameter can correspond to a full path or to a relative path in relation to the current directory (returned by fCurrentDir). This parameter is case sensitive.
Reminder: On iPhone/iPad, an application has the rights to write into its setup directory or into one of its subdirectories.

With an OLE DB access or a Native Connector (also called Native Access) Hide the details

<Result> = HChangeDir(<Logical file name> , <New database>)

<Result>: Boolean

True if the operation was performed,
False if a problem occurred. HError is used to identify the error.

<Logical file name>: Character string (with or without quotes)

Logical name of table (defined in the analysis).
If this parameter is equal to "*", HChangeDir is ignored.
Caution: If this parameter is equal to "*" and if one of the data files found in the analysis was associated with a connection (HChangeConnection) before the call to HChangeDir, the directory modification will be taken into account for this data file when closing the connection.

<New database>: Character string (with quotes)

Access path to database to use (up to 260 characters). In this case, the database name specified in the connection properties of table in the analysis is ignored.
This path can contain the name of drive and directories, or it can be a relative path.
If the path is a relative path, the "." (or "?") character is used to specify the current directory and the ".." character is used to specify the parent directory.
No relative path can be used.

Remarks

Multiple changes of directory

HChangeDir can be called several times with different parameters. When the path is redefined several times for the same data file, the last specified path replaces all the other ones.

Changing the name of data file

HChangeDir can only be used to change the access path to the physical data file. To modify the physical name of data file, use HChangeName.

Substituting directories

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

Caution: The substitution 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")
HCreation(Stat) // File created in C:\New\JanStats

Various

If the management of ".REP" is enabled (HSetREP), the path modification is saved in ".REP" file (see management of .REP).
Closing the data file stores the new path but does not store a possible password specified when opening the data file.
HChangeDir is equivalent to HAssign available in the earlier versions.
This function can be used when establishing a connection with a HFSQL server. Caution: The order in which the functions for connecting to a HFSQL Client/Server database are called is important. See Optimizing the connection times to the HFSQL Client/Server databases for more details.
HChangeDir can be used with the Native XML Access.

Component : wd240hf.dll