ONLINE HELP
 WINDEVWEBDEV AND WINDEV MOBILE

This content has been translated automatically.  Click here  to view the French version.
Help / WLanguage / Managing databases / HFSQL Cluster / WLanguage functions
WINDEV
WindowsLinuxJavaReports and QueriesUser code (UMC)
WEBDEV
WindowsLinuxPHPWEBDEV - Browser code
WINDEV Mobile
AndroidAndroid Widget iPhone/iPadIOS WidgetApple WatchMac Catalyst
Others
Stored procedures
Reads and modifies the parameters of an HFSQL cluster.
Example
// Lecture du nom DNS du cluster
sDNS is string 
sDNS = HClusterParameter("clustermanager.mondomaine.com", "secret", hCPDNS)
InfoBuild("Utilisez <%1> comme adresse de serveur dans vos applications" + ...
    " clientes pour vous connecter au cluster.", sDNS)
Syntax

Finding out the value of a cluster parameter Hide the details

<Result> = HClusterParameter(<Coordinator> , <Password> , <Parameter>)
<Result>: Character string
Parameter value.
<Coordinator>: Character string
DNS name of the cluster coordinator's machine.
<Password>: Character string or Secret string
Password used to connect to the coordinator. This password was supplied at the time of installing the cluster.
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.
<Parameter>: Integer constant
Parameter to read. The possible values are:
hCPClientPortListening port of client connections.
Remark: This parameter will be modified the next time the cluster is restarted.
hCPDNSCluster DNS name. This parameter is for information only.
Note It is important not to confuse:
  • cluster name (corresponding to the value associated with this parameter): name used to access cluster databases.
  • coordinator name (used in parameter <Coordinateur>): name (DNS) of the machine on which the cluster coordinator has been installed.
  • node name (not used by this function): name (DNS) of the machine on which the new HFSQL server has been installed.
New in version 2025
hCTelemetryActive
Parameter <Active> in the TELEMETRY section of the clustermanager.conf file
Data transmission configuration for HFSQL Cluster enhancement.
Value:
  • 1, if data transmission (telemetry) was enabled when the HFSQL Cluster was installed,
  • 0, if data transmission (telemetry) was refused when the HFSQL Cluster was installed,
  • another value if no choice was made during the setup regarding the use of telemetry. This question will be asked again the next time you install the HFSQL Cluster.
Note If the "TELEMETRY" section does not exist in the clustermanager.conf file, transmission of product usage data is not enabled for the HFSQL Cluster.

Modifying the value of a cluster parameter Hide the details

<Result> = HClusterParameter(<Coordinator> , <Password> , <Parameter> [, <New value>])
<Result>: Character string
Former value of parameter.
<Coordinator>: Character string
DNS name of the cluster coordinator's machine.
<Password>: Character string or Secret string
Password used to connect to the coordinator. This password was supplied at the time of installing the cluster.
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.
<Parameter>: Integer constant
Parameter to modify. The possible values are:
hCPClientPortListening port of client connections.
Remark: This parameter will be modified the next time the cluster is restarted.
hCPDNSCluster DNS name. This parameter is for information only.
Note It is important not to confuse:
  • cluster name (corresponding to the value associated with this parameter): name used to access cluster databases.
  • coordinator name (used in parameter <Coordinateur>): name (DNS) of the machine on which the cluster coordinator has been installed.
  • node name (not used by this function): name (DNS) of the machine on which the new HFSQL server has been installed.
New in version 2025
hCTelemetryActive
Parameter <Active> in the TELEMETRY section of the clustermanager.conf file
Data transmission configuration for HFSQL Cluster enhancement.
Value:
  • 1, if data transmission (telemetry) was enabled when the HFSQL Cluster was installed,
  • 0, if data transmission (telemetry) was refused when the HFSQL Cluster was installed,
  • another value if no choice was made during the setup regarding the use of telemetry. This question will be asked again the next time you install the HFSQL Cluster.
Note If the "TELEMETRY" section does not exist in the clustermanager.conf file, transmission of product usage data is not enabled for the HFSQL Cluster.
<New value>: Optional character string
New value for the parameter.
Business / UI classification: Business Logic
Component: wd300hf.dll
Minimum version required
  • Version 15
This page is also available for…
Comments
Click [Add] to post a comment

Last update: 05/16/2025

Send a report | Local help