IWorksAsyncDriver interface : GetListOfAsyncTasks method

GetListOfAsyncTasks method
Description
VWorks software calls the GetListOfAsyncTasks method to get the list of the currently executing asynchronous tasks from the plugin. The list identifies the tasks in the Name (task ID) and Value (location name) attributes of each Parameter element. VWorks software uses this list to keep track of which locations are busy and which are available.
Syntax
 
HRESULT GetListOfAsyncTasks(
[out,retval] BSTR *AsyncTaskIdLocationXML)
);
Parameters
 
[out, retval] An AsyncTaskList XML block that contains the list of the currently executing asynchronous tasks.
GetListOfAsyncTasks method output
The plugin returns an AsyncTaskList XML block in the AsyncTaskIdLocationXML parameter of the GetListOfAsyncTasks method.
AsyncTaskList XML block
The AsyncTaskList XML block contains the AsyncTaskList element and all its children. This XML block provides the list of asynchronous tasks that are currently executing. The tasks are identified in the Name (task ID) and Value (location name) attributes of each Parameter element.
XML structure
The value of the file attribute for the Velocity11 element is MetaData. See “Velocity11 element” .
 
<AsyncTaskList>
<Parameters>
<Parameter />
...
</Parameters>
</AsyncTaskList>
AsyncTaskList element
The AsyncTaskList element contains one Parameters element.
Parameters element
The Parameters element contains one or more Parameter elements.
Parameter element
Each Parameter element contains the task ID and location name of a currently executing asynchronous task. This element has the following attributes:
:
 
Possible values range from 1 to 2147483647 (INT_MAX).
Example of GetListOfAsyncTasks method output
The following sample code is an AsyncTaskList XML block that is returned to VWorks software by the plugin as a string in the AsyncTaskIdLocationXML parameter of the GetListOfAsyncTasks method. The plugin tells VWorks software that the asynchronous tasks named 3, 11, and 21 are currently executing.
 
<AsyncTaskList >
<Parameters >
<Parameter Name='3' Value='Location1' />
<Parameter Name='11' Value='Location2' />
<Parameter Name='21' Value='Location3' />
</Parameters>
</AsyncTaskList>
Related information