ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

Help / WLanguage / Managing databases / HFSQL / HFSQL functions
  • Password
WINDEV
WindowsLinuxJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac Catalyst
Others
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).
Please note Links are not managed (existing links cannot be created or updated).
To update links, use <Source>.UpdateLink.
Example
// Update the structure of data file Customer in the background
Customer.ModifyStructure(hmsBackgroundTask)
Syntax
<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).
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.
hmsNormal
(Default value)
Default operating mode of the automatic data modification.
New in version 2025
hmsSavegardeJournal
The following steps are performed during automatic data modification:
  • Backup log files (in log file backup directory).
  • Deleting log files.
  • Start automatic data modification.
AndroidAndroid Widget Constant not available.

Note: In hmsNormal or hmsWithoutControlmode, the data file being handled must not be opened (by the application or by another application)..
<New password>: Optional string or Secret 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.
New in version 2025
Secret strings: If you use the secret string vault, the type of secret string used for this parameter must be "ANSI or Unicode string".
To learn more about secret strings and how to use the vault, see Secret string vault.
<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.
AndroidAndroid Widget iPhone/iPadJava This parameter is not available.
Remarks

Password

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…
Comments
Click [Add] to post a comment

Last update: 05/14/2025

Send a report | Local help