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:

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

Prototype Signature:

success SetPath(char* pathName);


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

#include <malloc.h>
#include <string.h>
#include "api.h"

int main()
{
   success successful;

   //Initialize the library with a specific configuration file
   successful = Initialize("C:\\Temp\\MyConfig.ini");
   if(successful)
   {
       //Set the switch to Path_1
       successful = SetPath("Path_1");
       if(successful)
           printf("Success");
       else
           printf("Failure");
   }
}