Cicode Programming Reference > Cicode Function Categories > Server Functions Introduction > ServerIsOnline

ServerIsOnline

The ServerIsOnline function checks if the given server can be contacted by the client for giving the online/offline status of the server.

Syntax

ServerIsOnline(sServerName[, sClusters])

sServerName:

The name of the server to be queried in quotations marks "".

sCluster:

The cluster of the server to be queried in quotation marks "". An empty string indicates that the default cluster will be used.

Return Value

An integer value of online/offline status. Returns 1 for online, 0 for offline.

Related Functions

ServerGetProperty, ServerInfo, ServerInfoEx, ServerReload, ServerRestart

Example

ServerIsOnline("AlarmServer1", "Cluster12");

See Also