HModifyStructure (Function)

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.

Versions 25 and later
To update links, use HUpdateLink.

New in version 25
To update links, use HUpdateLink.

To update links, use HUpdateLink.

Versions 27 and later
HFSQL cluster: HModifyStructure can be used with HFSQL clusters.

New in version 27
HFSQL cluster: HModifyStructure can be used with HFSQL clusters.

HFSQL cluster: HModifyStructure can be used with HFSQL clusters.

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

This function is now available for 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 Android applications (for HFSQL data files).

This function is now available for 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 Android applications (for HFSQL data files).

This function is now available for Java applications.

Remark: From version 19, HFSQL is the new name of HyperFileSQL.

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.

Example

See additional examples

// Update the structure of data file Customer in the background
HModifyStructure(Customer, hmsBackgroundTask)

Syntax

<Result> = HModifyStructure(<Data file> [, <Option> [, <New password> [, <Backup> [, <Progress Bar>]]]])

<Result>: Boolean

True if the automatic data modification was performed,
False otherwise. ErrorInfo and HErrorInfo are used to identify the error.

<Data file>: Character string

Name of data file (defined in the analysis) whose structure must be updated.
If this parameter is equal to "*", the automatic data modification will be applied to all the 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).

<Option>: Optional constant (or combination of constants)

Options for the automatic data modification:
hmsBackgroundTask A hot automatic modification is performed (available for the HFSQL Client/Server data files only).
This constant is not available.
hmsNoCheck The 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.

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.

<Backup>: 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.
This parameter is not available.

Remarks

Password

If HModifyStructure 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 HPass. If the password is incorrect:

HErrorPassword returns True.
HModifyStructure returns False.

Business / UI classification: Business Logic

Component: wd270hf.dll