XJTAG logo
Open search box button
Close search button

StartFunction Method (string, XJEaseParameterCollection, XJEaseParameterCollection)

Runs an XJEase function with the specified name from the project's circuit code files. The XJEase functions are run asynchronously, i.e. control returns immediately from this method and the XJEase code continues to run on a separate thread.

Type: Runner

Namespace: XJTAG.Integration.XJRunner

Syntax

public void StartFunction(string functionName, XJEaseParameterCollection inputArgs, XJEaseParameterCollection outputArgs)

Parameters

functionName

Type: string

The name of the XJEase test function to run.

inputArgs

Type: XJEaseParameterCollection

The XJEaseParameterCollection of input arguments for the function. An arbitrary number of IntParameter, StringParameter and XJEaseArrayParameter arguments can be added to the collection, corresponding to the parameters for the function to be run.

outputArgs

Type: XJEaseParameterCollection

The XJEaseParameterCollection of initial values for the output arguments; individual arguments can be initialised as null.

Exceptions

RuntimeException

There was an error running the XJEase code.

System.ArgumentException

The function name was an empty string.

System.ArgumentNullException

Any of the arguments were null.

System.ObjectDisposedException

The Runner has already been disposed.