HClusterParameter (Function)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

HClusterParameter (Function)

In french: HClusterParamètre

Available only with this kind of connection

Reads and modifies the parameters of an HFSQL cluster.

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

Example

// Read the DNS name of server
sDNS is string
sDNS = HClusterParameter("clustermanager.mydomain.com", "secret", hCPDNS)

InfoBuild("Use <%1> as server address in your client applications" + ...
" to connect to the 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 (with quotes)

DNS name of computer where the cluster coordinator is installed.

<Password>: Character string (with quotes)

Password used to connect to the coordinator. This password was given when installing the cluster.

<Parameter>: Integer constant

Parameter to read. The possible values are:
hCPDNS DNS name of cluster. This parameter is for information only.
Remark: It is important not to confuse:
the name identifying the cluster (corresponding to the value associated with this parameter): name that will be used to access the cluster databases.
the name identifying the coordinator (used in the <Coordinator> parameter): DNS name of computer where the cluster coordinator was installed.
the name identifying the node (not used by this function): DNS name of computer where the new HFSQL server was installed.
hCPClientPort Listening port of client connections.

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 (with quotes)

DNS name of computer where the cluster coordinator is installed.

<Password>: Character string (with quotes)

Password used to connect to the coordinator. This password was given when installing the cluster.

<Parameter>: Integer constant

Parameter to modify. The possible values are:
hCPDNS DNS name of cluster. This parameter is for information only.
Remark: It is important not to confuse:
the name identifying the cluster (corresponding to the value associated with this parameter): name that will be used to access the cluster databases.
the name identifying the coordinator (used in the <Coordinator> parameter): DNS name of computer where the cluster coordinator was installed.
the name identifying the node (not used by this function): DNS name of computer where the new HFSQL server was installed.
hCPClientPort Listening port of client connections.
Remark: The modification of this parameter will be taken into account when restarting the cluster.

<New value>: Optional character string (with quotes)

New value for the parameter.

Business / UI classification: Business Logic

Component: wd260hf.dll