FunctionFinishedEventArgs Class

Provides data for the FunctionFinished event fired by an instance of Runner.

Namespace: XJTAG.Integration.XJRunner

Syntax

public class FunctionFinishedEventArgs : EventArgs

Example

In this case we subscribe to the FunctionFinished event of a Runner instance and give an example of how the FunctionFinishedEventArgs object is used to extract information from the event.

class Testing
{
    Runner runner;
    TestCollection testList;

    uint lastFunctionResult;
    string lastFunctionName;
    string lastFunctionTestGroupName;

    void InitialiseRunner()
    {
        /*
         * ...
         * Code to obtain Runner object from project and get test list.
         *...
         */

        // Subscribe to FunctionFinished event.
        runner.FunctionFinished += runner_FunctionFinished;

        // Run tests.
        runner.RunTests(testList);
    }

    void runner_FunctionFinished(object sender, FunctionFinishedEventArgs e)
    {
        // We use the FunctionFinishedEventArgs to retrieve information on the function that has
        // finished being run.

        // Get the uint returned from XJEase.
        lastFunctionResult = e.Result;

        // Get the name of the TestFunction that has finished and the TestGroup it belongs to.
        lastFunctionTestGroupName = e.Function.TestGroup.Name;
        lastFunctionName = e.TestFunction.Name;
    }
}

Inheritance Hierarchy

  • EventArgs
    • object

Members

Fields

Name Description
Function

The TestFunction on which testing has finished.

Outputs

The output arguments of the function if it is a function called from the circuit code files.

Result

The result of the function if it is a test function.

StopMode

The reason the function has finished, specified by one the values of the ExecutionTerminationMode enumeration.

Methods

Name Description
Equals(object) (from object)
Finalize (from object)
GetHashCode (from object)
GetType (from object)
MemberwiseClone (from object)
ToString (from object)