Click or drag to resize

ListAPIGetListStatus Method

Returns the current status of a command list on the card.

Namespace: RAYLASE.SPICE3.ClientLib
Assembly: RAYLASE.SPICE3.ClientLib (in RAYLASE.SPICE3.ClientLib.dll) Version: 3.12.2
Syntax
C#
Copy
public ListStatus GetListStatus(
	int listID
)

Parameters

listID  Int32
The ID of the command list to query.

Return Value

ListStatus
The current status of the list, indicating whether it exists on the card and where it stands in the translation pipeline.
Remarks

None of the states returned by this method reflect the activity of the execution engine — they describe the state of the card's translation pipeline only. Do not use Idle as a confirmation that commands have finished executing. To be notified when all commands in a list have been executed, either call WaitForListDone(NullableInt32, NullableInt32) or register a callback via RegisterListDoneCallback(ActionClientAPI, Int32).

For a full explanation of list states and their relation to the execution pipeline, see 12.5.3 Command List States.

See Also