Execute a sequence as defined in a Sequence section of the configuration file. See also LogSequence.

Parameters:

seqName

The name of the sequence configuration section that defines this sequence.

Return Value:

True on Success.    If the function fails use GetErrorMessage to get the specific errors associated with the failure.

Interface Signature:

bool RunSequence(string seqName);


An example of how this function is used  is shown below.

using System;

namespace Example
{
   /// <summary>
   /// An simple example of how to utilize the API and get a reference to it
   /// </summary>
   public class ExampleClass
   {
       /// <summary>
       /// Run a sequence and log the events
       /// </summary>
       public static bool Calibrate(string calName, string pnaName)
       {
           // Get a reference to the API interface
           AteSystems.InCal.IApi api = AteSystems.InCal.API.Initialize(@"C:\Temp\MyConfig.ini", catchExceptions:true);
           // Call the API function
           return api.RunSequence("SEQ_1");
       }
   }
}