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


This function allows the user to determine if a cluster is active.




The name of the cluster to query enclosed in quotation marks "".

Return Value

TRUE if active, FALSE otherwise. If the cluster name was invalid, this function will return FALSE and a hardware alarm will be generated.

Related Functions

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

See Also

Cluster Functions

About cluster context