Click or drag to resize

ListAPITryWaitForListDone Method

Waits up to timeout for a ListDone event to be reported from the card.

Namespace: RAYLASE.SPICE3.ClientLib
Assembly: RAYLASE.SPICE3.ClientLib (in RAYLASE.SPICE3.ClientLib.dll) Version: 3.4.1
Syntax
C#
public bool TryWaitForListDone(
	out int? listID,
	int? timeout = null
)

Parameters

listID  NullableInt32
Receives the Card-CommandList Identifier of the first list which was executed to completion since the last time this function was called.
timeout  NullableInt32  (Optional)
null
(or omitted)
use the default timeout period specified by ClientAPITimeout
  -1wait indefinitely for the event
   0do not wait, simply check if an event has already been reported
 > 0timeout period in ms

Return Value

Boolean
trueif an event is reported within the specified timeout period,
falseotherwise.
Exceptions
Remarks
  • Note that in case of a timeout this function will always return false.

    See WaitForListDone(NullableInt32, NullableInt32) if you wish to wait for a TimeoutException instead.

  • Waiting can be interrupted by calling InterruptWaitForListDone.

    Doing so will cause a ThreadInterruptedException.

  • Like all methods which involve communication with the card, this method is not thread-safe.
  • An executionDone event occurs when execution of a list has completely finished (all micro-vectors have been output), and only if execution was triggered explicitly by calling ListAPIExecute(Int32).
  • Sublists do not trigger executionDone events.
See Also