IScheduledWorkItem::GetFlags method (mstask.h)

Article
02/22/2024

[[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.] ]

Retrieves the flags that modify the behavior of any type of work item.

Syntax

HRESULT GetFlags(
  [out] DWORD *pdwFlags
);

Parameters

[out] pdwFlags

A pointer to a DWORD that contains the flags for the work item. For a list of these flags, see SetFlags.

Return value

The GetFlags 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.

Remarks

This method is used to get those flags used by any type of scheduled work item. In contrast, ITask::GetTaskFlags is used only to get flags used by scheduled tasks.

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