WaitForBoolean Method

VirtualUserScript WaitForBoolean Method

C# API

Returns a bool stored in the data dictionary. If the bool is not yet in the data dictionary, then this method will wait for up to the timeout for the bool to be added. For example, a foreground script may need to wait for a background script to put a bool into the data dictionary before continuing.

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

Syntax

C++

Copy to Clipboard Print

public bool WaitForBoolean(
	string key,
	TimeSpan timeout
)

public bool WaitForBoolean(
	string key,
	TimeSpan timeout
)

Parameters

key: Type: System String
The key to be looked up in the dictionary.

timeout: Type: System TimeSpan
The maximum amount of time to wait for the object to be added to the dictionary.

Return Value

An bool value held in the dictionary.

Exceptions

Exception	Condition
TimeoutException	The bool was not added to the dictionary before the timeout period elapsed.