Cicode Programming Reference > Cicode Function Categories > Cluster Functions Introduction > ClusterGetName

ClusterGetName

ClusterGetName is deprecated in this version of CitectSCADA.

Syntax

ClusterGetName(sPrimary, sStandby, nMode)

sPrimary:

The variable containing the name of the cluster's primary server (that is that which was set as sPrimary using the ClusterSetName() function).

sStandby:

The variable containing the name of the cluster's standby server (that is that which was set as sStandby using the ClusterSetName() function).

nMode:

The mode is for future expansion of the function - set to 0 (zero).

Return Value

The status of the get name.

Related Functions

ClusterActivate, ClusterDeactivate, ClusterFirst, ClusterIsActive, ClusterNext, ClusterServerTypes, ClusterSetName, ClusterStatus, ClusterSwapActive, TaskCluster

Example

// Return and display the server names.//
ClusterGetName(sPrimary, sStandby, 0);
Prompt("Name of Cluster" + sPrimary);

See Also

Cluster Functions

About cluster context