/// <summary>
/// Displays a graphics page.
/// </summary>
/// <param name="ctApi"></param>
/// <param name="page">The name or page number of the page to display.</param>
/// <param name="clusterName">The name of the cluster that will accommodate the page at runtime.</param>
/// <returns>0 (zero) if successful, otherwise an error code will return</returns>
public static async Task <string> PageDisplayAsync(this CtApi ctApi, string page, string clusterName = "")
{
var result = await ctApi.CicodeAsync($"PageDisplay({page}, {clusterName})");
return(result);
}
/// <summary>
/// Ends Citect SCADA's operation
/// </summary>
/// <param name="ctApi"></param>
/// <param name="dest">The destination computer(s) on which Citect SCADA will be shut down.</param>
/// <param name="project">The full path of the project to run on restart as a string.</param>
/// <param name="mode">The type of shutdown.</param>
/// <param name="clusterName">The name of the cluster to which the machine(s) named in Dest belong.</param>
/// <param name="callEvent">Flag for initiating a user-specified shutdown event prior to shutting down.</param>
/// <returns>0 (zero) if successful, otherwise an error code will return</returns>
public static async Task <string> ShutdownAsync(this CtApi ctApi, string dest = "", string project = "", int mode = 1, string clusterName = "", int callEvent = 0)
{
var result = await ctApi.CicodeAsync($"Shutdown({dest}, {project}, {mode}, {clusterName}, {callEvent})");
return(result);
}
/// <summary>
/// Enables alarms by tag name.
/// </summary>
/// <param name="ctApi"></param>
/// <param name="tag">A string that identifies the alarm to enable</param>
/// <param name="clusterName">The cluster where the tag resides</param>
/// <returns>0 (zero) if successful, otherwise an error code will return</returns>
public static async Task <string> AlarmEnableTagAsync(this CtApi ctApi, string tag, string clusterName = "")
{
var result = await ctApi.CicodeAsync($"AlarmEnableTag({tag}, {clusterName})");
return(result);
}
