XJTAG logo
Open search box button
Close search button

Getting Started

There are some common steps which need to be followed before you can use the API to run tests on your board:

  1. Get an XJLink instance which represents the physical XJLink attached to the board which will be used. Do this using the static GetXJLink method, which you can optionally provide with a serial number corresponding to the XJLink you wish to use.
  2. Create a RunnerProject instance, passing the constructor the path to an existing XJTAG project (this could be an XJPack file or an XJDeveloper project file, but not an XJAnalyser-created project file). If the given path refers to an XJPack file, an XJRunner licence is required to create the instance; if it refers to an XJDeveloper project, then XJEase and XJRunner licences are required.
  3. Use the GetTestList method on the project instance to create a TestCollection instance. This object contains all test groups and functions in the XJRunner Test List, and each of these can be set to run any number of times using its Loops property.
  4. Use the GetRunner method on the project instance to create a Runner instance, passing in the XJLink instance created previously. Use the RunTests method on this class to run the full XJRunner Test List that was configured in the previous step, or the RunTest method to just run a single test function.

Once each of the XJLink, RunnerProject, and ChainRunner instances has been finished with, they should be disposed using their corresponding Dispose methods. This ensures that memory used by those instances is freed up for future use, and that new instances of the objects can be created using the same underlying project and XJLink.

When your application has completely finished with the XJIntegration DLL, you must call the XjtagSystem.Close method in order to clear up background threads which the integration runs. If you do not do this, your application may hang on exit and not actually terminate.

XJRunner Integration types can be found in XJIntegration.dll under the XJTAG.Integration.XJRunner namespace. See the XJRunner Integration API reference for more details of the Interfaces and Classes included as well as their members.