WaitForBackgroundScriptToFinish Method

VirtualUser WaitForBackgroundScriptToFinish Method

C# API

Waits for the background script to finish work in the given timeout, if timeout is not provided or null it waits until the tasks finish (if at all), if timeout is not null, then it returns false if it expired before the timeout reached.

Namespace: Facilita.Fc.Runtime
Assembly: fc_clr (in fc_clr.dll) Version: 9.5.8.37

Syntax

C++

Copy to Clipboard Print

public bool WaitForBackgroundScriptToFinish(
	string id,
	TimeSpan timeout
)

public bool WaitForBackgroundScriptToFinish(
	string id,
	TimeSpan timeout
)

Parameters

id: Type: System String
Unique script ID, identifying the background script.

timeout: Type: System TimeSpan
How long to wait before give up. -1 ms timeout means indefinite timeout.

Return Value

true if the background script completed execution within the allotted time; otherwise, false.