Runs an automatic task on a set of files.
Automatic task template IDs are defined in AutomaticTaskTemplateIds.
This overload allows event handlers to be specified for task status and message events.
These events support cancellation of the task.
Namespace: Sdl.ProjectAutomation.CoreAssembly: Sdl.ProjectAutomation.Core (in Sdl.ProjectAutomation.Core.dll) Version: 1.0.0.0 (1.2.3064.0)
Syntax
C# |
---|
AutomaticTask RunAutomaticTask( Guid[] projectFileIds, string taskTemplateId, EventHandler<TaskStatusEventArgs> statusEventHandler, EventHandler<TaskMessageEventArgs> messageEventHandler ) |
Visual Basic |
---|
Function RunAutomaticTask ( _ projectFileIds As Guid(), _ taskTemplateId As String, _ statusEventHandler As EventHandler(Of TaskStatusEventArgs), _ messageEventHandler As EventHandler(Of TaskMessageEventArgs) _ ) As AutomaticTask |
Visual C++ |
---|
AutomaticTask^ RunAutomaticTask( array<Guid>^ projectFileIds, String^ taskTemplateId, EventHandler<TaskStatusEventArgs^>^ statusEventHandler, EventHandler<TaskMessageEventArgs^>^ messageEventHandler ) |
Parameters
- projectFileIds
- Type: array<System..::..Guid>[]()[][]
The files to run the task on.
- taskTemplateId
- Type: System..::..String
The ID of the task template (i.e. the type of task) to run.
- statusEventHandler
- Type: System..::..EventHandler<(Of <(<'TaskStatusEventArgs>)>)>
Event handler for task status events.
- messageEventHandler
- Type: System..::..EventHandler<(Of <(<'TaskMessageEventArgs>)>)>
Event handler for message events.
Return Value
Information about the automatic task that has been run.Remarks
Multiple automatic tasks can be run together in a sequence using FileBasedProject.RunAutomaticTasks