TaskStarting method

Event

A task started.

Description

VWorks software calls the TaskStarting method after a task starts.

Syntax

 

HRESULT TaskStarting( [in] BSTR sXML, [in, out] BSTR* sResultXML );

Parameters

 

sXML	[in] A TaskStarting XML block containing information about the task that started and about the protocol that generated the event.
sResultXML	[in, out] A HookResults XML block. See “HookResults XML block” .

TaskStarting method input

VWorks software passes a TaskStarting XML block into the sXML parameter of the TaskStarting method.

TaskStarting XML block

The TaskStarting XML block contains the TaskStarting element and all its children. This XML block provides information about the task that started, including the names of all devices and locations used by the task.

TaskStarting element

The TaskStarting element has two children: Devices and Locations. The TaskStarting element has the following attributes:

 

Name	Value
Description	The description of the task.
InstanceNumber	The labware instance number.
ProcessName	The name of the process.
ProcessIndex	If the task is in a main process, the value is the index of this process in the protocol (zero-based). If the task is in a subprocess, the value is always 0.
TaskIndex	The index of the task in the main process or in a subprocess (zero-based).
Path	The name of the protocol that generated the event. 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.
ProtocolPath	The name of the protocol that generated the event. This attribute has the same value as the Path attribute.
ProtocolType	Represents the protocol type. Possible values: 1 = Startup 2 = Main 3 = Cleanup
Spawned	Indicates whether the task is created by a Spawn Process task. Possible values: 0 = The task is not created by a Spawn Process task 1 = The task is created by a Spawn Process task

Devices element

The Devices element contains one or more Value elements.

Value element

Each Value element contains the name of a device used by the task. This element has the following attribute:

 

Name	Value
Value	The name of a device used by the task.

Locations element

The Locations element contains one or more Value elements.

Value element

Each Value element contains the name of a location used by the task. This element has the following attribute:

 

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

Example of TaskStarting method input

The following sample code is a TaskStarting XML element that is received by the plugin from VWorks software as a string in the sXML parameter of the TaskStarting method. VWorks software tells the plugin that the task named Place plate at PlatePad ‑ 1 Stage started in the Main Protocol.

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11 file='MetaData' md5sum='644ee98f1252ed195132158a86ecbb5c' version='1.0' > <TaskStarting Description='Place plate at PlatePad - 1 Stage' InstanceNumber='1' →Path='C:\V11\MyProtocol.pro' ProcessIndex='0' ProcessName='process - 1' →ProtocolPath='C:\V11\MyProtocol.pro' ProtocolType='2' Spawned='0' TaskIndex='0' > <Devices > <Value Value='PlatePad - 1' /> </Devices> <Locations > <Value Value='Stage' /> </Locations> </TaskStarting> </Velocity11>

TaskStarting method output

The plugin returns a HookResults XML block in the sResultXML parameter of the TaskStarting method. For information about the structure and contents of this XML block, see “HookResults XML block” .

Example of TaskStarting method output

The following sample code is a HookResults XML block that is returned to VWorks software by the plugin as a string in the sResultXML parameter of the TaskStarting method. The plugin tells VWorks software to write the following Info-type message to the Main Log:

Place plate at PlatePad ‑ 1 Stage task started.

 

<?xml version='1.0' encoding='ASCII' ?> <Velocity11 file='MetaData' md5sum='52226bb1b70c756162b551f1f5685a5d' version='1.0'> <HookResults> <Results> <HookResult ResultType='Log Message' →ResultValue='Place plate at PlatePad - 1 Stage task started.' /> </Results> </HookResults> </Velocity11>

Related information

 

For information about...	See...
HookResults XML block	“HookResults XML block”