Help / WLanguage / Managing databases / HFSQL / HFSQL functions
  • Password
WindowsLinuxUniversal Windows 10 AppJavaReports and QueriesUser code (UMC)
WindowsLinuxPHPWEBDEV - Browser code
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac CatalystUniversal Windows 10 App
Stored procedures
Allows you to update the structure of an HFSQL data file by performing an automatic data modification (also called Synchronization of the Structure of Deployed Data).
Caution: Links are not updated or created.
To update links, use <Source>.UpdateLink.
// Update the structure of data file Customer in the background
<Result> = <Source>.ModifyStructure([<Option> [, <New password> [, <Save> [, <Progress Bar>]]]])
<Result>: Boolean
  • True if the automatic data modification was performed,
  • False otherwise. ErrorInfo and HErrorInfo are used to identify the error.
<Source>: Type corresponding to the specified source
Name of data file (defined in the analysis) whose structure must be updated.
<Option>: Optional constant (or combination of constants)
Options for the automatic data modification:
hmsBackgroundTaskA hot automatic modification is performed (available for the HFSQL Client/Server data files only).
Universal Windows 10 App This constant is not available.
hmsNoCheckThe automatic data modification is performed even if:
  • the description of the file is more recent than the description of the analysis,
  • the GUID of the file differs from the GUID of the analysis.
(Default value)
Default operating mode of the automatic data modification.

Remark: In hmsNormal or hmsNoCheck mode, the data file used must not be opened (by the application or by another application).
<New password>: Optional character string
  • New password of the data file.
  • Empty string ("") to delete the password.
If this parameter is not specified (or if this parameter corresponds to NULL), the existing password is not modified.
<Save>: Optional character string
  • Backup directory.
  • Empty string ("") to perform no backup (default value).
<Progress Bar>: Optional control name or window name
Name of the Progress Bar control or name of the window that shows the progress of the automatic data modification.
Universal Windows 10 AppAndroidAndroid Widget iPhone/iPadJava This parameter is not available.


If <Source>.ModifyStructure is the first function that handles the specified data file, the password is checked when using the data file. This password must have been specified by <Source>.Password. If the password is incorrect:
Component: wd300hf.dll
Minimum version required
  • Version 25
This page is also available for…
Click [Add] to post a comment

Last update: 09/07/2023

Send a report | Local help