Click or drag to resize

ListAPI Class

Provides access to CommandList handling operations.
Inheritance Hierarchy
SystemObject
  RAYLASE.SPICE3.ClientLibSpice3API
    RAYLASE.SPICE3.ClientLibListAPI

Namespace: RAYLASE.SPICE3.ClientLib
Assembly: RAYLASE.SPICE3.ClientLib (in RAYLASE.SPICE3.ClientLib.dll) Version: 3.5.2
Syntax
C#
Copy
public class ListAPI : Spice3API

The ListAPI type exposes the following members.

Properties
 NameDescription
Public propertyEvents Provides access to Event settings.
Top
Methods
 NameDescription
Public methodAbortExecution Aborts execution immediately.
Public methodCode exampleClearPendingEvents Clears all pending Events (e.g. 'ListIdle', 'ListDone', 'Aborted', 'Progress', etc. ) from the internal EventQueue.
Public methodDelete Deletes the specified Card-CommandList on the card.
Public methodCode exampleExecute Executes the identified Card-CommandList.
Public methodGet Retrieves the contents of the identified Card-CommandList into a new Client-CommandList instance.
Public methodGetLastExecutionStats Gets the statistics from the latest list execution.
Public methodCode exampleGetListCaret Gets the identified Card-CommandList's current caret position.
Public methodGetListStatus Gets the current status of the identified Card-CommandList.
Public methodGetStoredListIDs Reads back a list of all CommandList that are stored on the card.
Public methodInterruptWaitForListDone Interrupts a current blocking call to WaitForListDone(NullableInt32, NullableInt32) and TryWaitForListDone(NullableInt32, NullableInt32).
Public methodInterruptWaitForListIdle Interrupts a current blocking call to WaitForListIdle(NullableInt32, NullableInt32) and TryWaitForListIdle(NullableInt32, NullableInt32).
Public methodInterruptWaitForProgress Interrupts a current blocking call to WaitForProgress(NullableInt32, NullableInt32) and TryWaitForProgress(NullableInt32, NullableInt32).
Public methodIsExecutionInProgress Checks if the execution engine is currently busy.
Public methodLoad Loads the contents of a Card-CommandList from a file on the card.
Public methodRegisterErrorEventCallback Register a callback function that is called when an error event occurs.
Public methodRegisterListDoneCallback Register a callback function that is called when an ListDone event occurs.
Public methodRegisterListIdleCallback Register a callback function that is called when an ListIdle event occurs.
Public methodRegisterProgressCallback Register a callback function that is called when an progress event occurs.
Public methodSet Transfers the contents of a Client-CommandList to the identified Card-CommandList.
Public methodStore Stores the contents of a Card-CommandList in a file on the card.
Public methodTryWaitForListDone Waits up to timeout for a ListDone event to be reported from the card.
Public methodTryWaitForListIdle Waits up to timeout for a ListIdle event to be reported from the card.
Public methodTryWaitForProgress Waits up to timeout for a Progress Event to be reported from the card.
Public methodUnregisterErrorEventCallback Unregister a callback previously registered with RegisterErrorEventCallback(ActionClientAPI, Int32, Exception).
Public methodUnregisterListDoneCallback Unregister a callback previously registered with RegisterListDoneCallback(ActionClientAPI, Int32).
Public methodUnregisterListIdleCallback Unregister a callback previously registered with RegisterListIdleCallback(ActionClientAPI, Int32).
Public methodUnregisterProgressCallback Unregister a callback previously registered with RegisterProgressCallback(ActionClientAPI, Int32).
Public methodWaitForListDone Waits up to timeout for a ListDone event to be reported from the card.
Public methodWaitForListIdle Waits up to timeout for a ListIdle event to be reported from the card.
Public methodWaitForProgress Waits up to timeout for a Progress Event to be reported from the card.
Top
See Also