Asynchronous Task Command XML block components

VWorks software passes an Asynchronous Task Command XML block into the AsyncXML parameter of the Abort, Ignore, and Retry methods. The following table lists the XML components that are contained in this XML block for each method. The elements and attributes are described in the sections that follow. You can click an element name to jump to the appropriate section.

The elements and attributes preceded by an asterisk are of interest to an implementer of the IWorksAsyncDriver interface.

 

	Method name
Element name Attribute name	Abort — terminate a specific task	Abort — terminate all executing tasks	Ignore	Retry
Command	✓	✓	✓	✓
Compiler	✓	✓	✓	✓
Editor	✓	✓	✓	✓
Description	✓		✓	✓
*Name	✓		✓	✓
NextTaskToExecute	✓	✓	✓	✓
ProtocolName	✓		✓	✓
RequiresRefresh	✓	✓	✓	✓
TaskRequiresLocation	✓	✓	✓	✓
VisibleAvailability	✓	✓	✓	✓
Parameters	✓
Parameter	✓ (multiple)
Description	✓
Hide_if	✓
*Name	✓
Scriptable	✓
Style	✓
Type	✓
Units	✓
*Value	✓
Ranges	✓
Range	✓
Value	✓
Locations	✓
*Value	✓
AsyncParameters	✓	✓	✓	✓
AsyncParameter	✓	✓	✓	✓
*Name	✓		✓	✓
Async_ErrorDescription
Async_TaskID		✓	✓	✓
Async_TaskVWorksID			✓	✓
Async_Location			✓	✓
*Value	✓

Command element

The Command element contains one Parameters element, one Locations element, and one AsyncParameters element. The Command element has the following attributes.

 

Name	Value
Compiler	See “Compiler attribute” .
Editor	See “Editor attribute” .
*Name	The name of the asynchronous task.
NextTaskToExecute	See “NextTaskToExecute attribute” .
RequiresRefresh	See “RequiresRefresh attribute” .
TaskRequiresLocation	See “TaskRequiresLocation attribute” .
VisibleAvailability	See “VisibleAvailability attribute” .
Description	The description of the asynchronous task.
ProtocolName	The name of the protocol that contains the asynchronous task. If the protocol has been saved, the value of this attribute is the protocol’s file path. If the protocol has not been saved, the value is the default protocol name.

Parameters element

The Parameters element contains one or more Parameter elements.

Parameter element

The Parameter element can contain one Ranges element and has the following attributes:

 

Name	Value
Description	The description of the parameter.
Hide_if	See “Hide_if attribute” .
*Name	The name of the parameter.
Scriptable	See “Scriptable attribute” .
Style	See “Style attribute” .
Type	See “Type attribute” .
Units	See “Units attribute” .
*Value	See “Value attribute” .

Ranges element

The Ranges element contains one or more Range elements.

Range element

The Range element has the following attribute:

 

Name	Value
Value	See “Value attribute” .

Locations element

The Locations element contains one of more Value elements.

Value element

The Value element contains the following attribute:

 

Name	Value
Value	The name of a location used by the asynchronous task.

AsyncParameters element

The AsyncParameters element contains five AsyncParameter elements.

AsyncParameter element

Each AsyncParameter element has one of the following pairs of Name and Value attributes:

 

Name	Value
Name   Value	The value Async_TaskVWorksID. Required: Yes The task ID of the asynchronous task, which is automatically generated by VWorks software and used by VWorks software to identify and manage all asynchronous tasks from all plugins. Required: Yes Note: The AsyncParameters element contains two Async_TaskVWorksID elements.
Name   Value	The value Async_ErrorDescription. Required: Yes The description of the error that occurred. Required: Yes
Name   Value	The value Async_TaskID. Required: Yes The task ID of the asynchronous task, which is generated by the plugin and used by the plugin to identify and manage its asynchronous tasks. Required: Yes
Name   Value	The value Async_Location. Required: Yes The name of the location where the error occurred. Required: Yes