Edit

Share via

IRDVTaskPluginNotifySink::ScheduleTask method

  • Article

Called by the task agent to schedule a task.

Syntax

HRESULT ScheduleTask(
  [in] FILETIME        ftStartTime,
  [in] FILETIME        ftEndTime,
  [in] FILETIME        ftDeadline,
  [in] BSTR            bstrLabel,
  [in] BSTR            bstrIdentifier,
  [in] SAFEARRAY(BYTE) saContext
);

Parameters

ftStartTime [in]

Type: FILETIME

The earliest task start time, in UTC.

ftEndTime [in]

Type: FILETIME

The task end time, in UTC. Pass a FILETIME set to all zeros if no end time is specified.

ftDeadline [in]

Type: FILETIME

The task deadline, in UTC. This is used to set priority for multiple tasks that are within their start window. If more than one task should be started, the one with the earliest deadline will be started first.

bstrLabel [in]

Type: BSTR

The label for the task. This is passed to the StartTask method.

bstrIdentifier [in]

Type: BSTR

The identifier of the task. This is passed to the StartTask method.

saContext [in]

Type: SAFEARRAY(BYTE)

Optional data for the task. This is passed to the StartTask method.

Return value

Type: HRESULT

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

Requirements

Requirement Value
Minimum supported client
 Windows 7 Enterprise
Minimum supported server
 Windows Server 2008 R2

See also

IRDVTaskPluginNotifySink