WaitForCompletion Method (TimeSpan)

Waits for the specified time period for any active test run on a background thread to complete.

Type: Runner

Namespace: XJTAG.Integration.XJRunner

Syntax

public bool WaitForCompletion(TimeSpan timeout)

Parameters

timeout

Type: System.TimeSpan

The maximum time to wait for tests to complete.

Return Value

bool

True if the test completed within the timeout period, false if the timeout period expired.

Exceptions

RuntimeException

An error occurred running the XJEase code.

System.ArgumentOutOfRangeException

The timeout value is negative or too long.

System.ObjectDisposedException

The Runner has already been disposed.

Remarks

The maximum timeout value is int.MaxValue milliseconds.

WaitForCompletion must be called after running any function asynchronously, either with StartFunction or StartTesting. If a TimeSpan is provided, then the method must return true before any other function is run.