Provides access to CommandList handling operations.
Inheritance Hierarchy Namespace: RAYLASE.SPICE3.ClientLibAssembly: RAYLASE.SPICE3.ClientLib (in RAYLASE.SPICE3.ClientLib.dll) Version: 3.7.0
Syntaxpublic class ListAPI : Spice3API
The ListAPI type exposes the following members.
Properties | Name | Description |
---|
 | Events |
Provides access to Event settings.
|
Top
Methods | Name | Description |
---|
 | AbortExecution |
Aborts execution immediately.
|
  | ClearPendingEvents |
Clears all pending Events (e.g. 'ListIdle', 'ListDone', 'Aborted', 'Progress', etc. ) from the internal EventQueue.
|
 | Delete |
Deletes the specified Card-CommandList on the card.
|
  | Execute |
Executes the identified Card-CommandList.
|
 | Get |
Retrieves the contents of the identified Card-CommandList into a new Client-CommandList instance.
|
 | GetLastExecutionStats |
Gets the statistics from the latest list execution.
|
  | GetListCaret |
Gets the identified Card-CommandList's current caret position.
|
 | GetListStatus |
Gets the current status of the identified Card-CommandList.
|
 | GetStoredListIDs |
Reads back a list of all CommandList that are stored on the card.
|
 | InterruptWaitForListDone |
Interrupts a current blocking call to WaitForListDone(NullableInt32, NullableInt32) and TryWaitForListDone(NullableInt32, NullableInt32).
|
 | InterruptWaitForListIdle |
Interrupts a current blocking call to WaitForListIdle(NullableInt32, NullableInt32) and TryWaitForListIdle(NullableInt32, NullableInt32).
|
 | InterruptWaitForProgress |
Interrupts a current blocking call to WaitForProgress(NullableInt32, NullableInt32) and TryWaitForProgress(NullableInt32, NullableInt32).
|
 | IsExecutionInProgress |
Checks if the execution engine is currently busy.
|
 | Load |
Loads the contents of a Card-CommandList from a file on the card.
|
 | RegisterErrorEventCallback |
Register a callback function that is called when an error event occurs.
|
 | RegisterListDoneCallback |
Register a callback function that is called when an ListDone event occurs.
|
 | RegisterListIdleCallback |
Register a callback function that is called when an ListIdle event occurs.
|
 | RegisterProgressCallback |
Register a callback function that is called when an progress event occurs.
|
 | Set |
Transfers the contents of a Client-CommandList to the identified Card-CommandList.
|
 | Store |
Stores the contents of a Card-CommandList in a file on the card.
|
 | TryWaitForListDone |
Waits up to timeout for a ListDone event to be reported from the card.
|
 | TryWaitForListIdle |
Waits up to timeout for a ListIdle event to be reported from the card.
|
 | TryWaitForProgress |
Waits up to timeout for a Progress Event to be reported from the card.
|
 | UnregisterErrorEventCallback |
Unregister a callback previously registered with RegisterErrorEventCallback(ActionClientAPI, Int32, Exception).
|
 | UnregisterListDoneCallback |
Unregister a callback previously registered with RegisterListDoneCallback(ActionClientAPI, Int32).
|
 | UnregisterListIdleCallback |
Unregister a callback previously registered with RegisterListIdleCallback(ActionClientAPI, Int32).
|
 | UnregisterProgressCallback |
Unregister a callback previously registered with RegisterProgressCallback(ActionClientAPI, Int32).
|
 | WaitForListDone |
Waits up to timeout for a ListDone event to be reported from the card.
|
 | WaitForListIdle |
Waits up to timeout for a ListIdle event to be reported from the card.
|
 | WaitForProgress |
Waits up to timeout for a Progress Event to be reported from the card.
|
Top
See Also