FX3ConnectionWaitForStreamCompletion Method (Int32)

Blocks until the streaming endpoint mutex can be acquired. Allows a user to synchronize external application the completion of a stream. Returns false if there is not a stream running, or if the timeout is reached without the stream mutex being acquired.

Namespace: FX3Api
Assembly: FX3Api (in FX3Api.dll) Version: 2.9.4.0 (2.9.4)

Syntax

C++

Copy

public bool WaitForStreamCompletion(
	int MillisecondsTimeout
)

Public Function WaitForStreamCompletion ( 
	MillisecondsTimeout As Integer
) As Boolean

public:
bool WaitForStreamCompletion(
	int MillisecondsTimeout
)

member WaitForStreamCompletion : 
        MillisecondsTimeout : int -> bool

Parameters

MillisecondsTimeout: Type: SystemInt32
The time to wait trying to acquire the stream mutex (ms)

Return Value

Type: Boolean
If the stream wait was successful

Reference

FX3Connection Class

WaitForStreamCompletion Overload

FX3Api Namespace

FX3ConnectionAddLanguageSpecificTextSet("LST54986020_0?cpp=::|nu=.");WaitForStreamCompletion Method (Int32)

Parameters

Return Value

Reference

FX3ConnectionWaitForStreamCompletion Method (Int32)