Sets the switch controller to the specified switch path.

The path name can be the following:

  • An explicit switch path.
  • The section name of another path

Parameters:

pathName

The name of the path 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 SetPath(string pathName);


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

using System;

namespace Example
{
   /// <summary>
   /// An simple example of how to set a path
   /// </summary>
   public class ExampleClass
   {
       /// <summary>
       /// Set the switches as specified in the named path
       /// </summary>
       public static void SetAPath(string pathName)
       {
           // Get a reference to the API interface
           AteSystems.InCal.IApi api = AteSystems.InCal.API.Initialize(@"C:\Temp\MyConfig.ini", catchExceptions:false);
           // Call the API function
           return api.SetPath(pathName);
       }
   }
}