ITaskHandler::Start method (taskschd.h)

Called to start the COM handler. This method must be implemented by the handler.

Syntax

HRESULT Start(
  [in] IUnknown *pHandlerServices,
  [in] BSTR     data
);

Parameters

[in] pHandlerServices

An IUnkown interface that is used to communicate back with the Task Scheduler.

[in] data

The arguments that are required by the handler. These arguments are defined in the Data property of the COM handler action.

Return value

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

When implementing this method, the handler should return control immediately to the Task Scheduler (starting its own thread if inproc).

After the handler starts its processing, it can call the UpdateStatus method to indicate its percentage of completion or call the TaskCompleted method to indicate when the handler has completed its processing. These methods are provided by the ITaskHandlerStatus interface.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header taskschd.h
Library Taskschd.lib
DLL Taskschd.dll

See also

Data

ITaskHandler

ITaskHandlerStatus

Task Scheduler

TaskCompleted

UpdateStatus