Edit

ITask::GetTaskFlags method (mstask.h)

  • Article

[[This API may be altered or unavailable in subsequent versions of the operating system or product. Please use the Task Scheduler 2.0 Interfaces instead.] ]

This method returns the flags that modify the behavior of a task.

Syntax

HRESULT GetTaskFlags(
  [out] DWORD *pdwFlags
);

Parameters

[out] pdwFlags

Currently, there are no defined flags for scheduled tasks.

Return value

The GetTaskFlags method returns one of the following values.

Return code Description
S_OK
 The operation was successful.
E_INVALIDARG
 The arguments are not valid.
E_OUTOFMEMORY
 Not enough memory is available.
 

This method is designed to get the flags that only apply to scheduled tasks. In contrast, IScheduledWorkItem::GetFlags is used to get the flags that apply to all types of scheduled work items.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header mstask.h
Library Mstask.lib
DLL Mstask.dll
Redistributable Internet Explorer 4.0 or later on Windows NT 4.0 and Windows 95

See also

IScheduledWorkItem::GetFlags

ITask

ITask::SetTaskFlags