ITask::SetPriority method (mstask.h)

[[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 sets the priority for the task.

Syntax

HRESULT SetPriority(
  DWORD dwPriority
);

Parameters

dwPriority

A DWORD that specifies the priority for the current task. The priority of a task determines the frequency and length of the time slices for a process. This applies only to the Windows Server 2003, Windows XP, and Windows 2000 operating systems. These values are taken from the CreateProcess priority class and can be one of following flags (in descending order of thread scheduling priority):

  • REALTIME_PRIORITY_CLASS
  • HIGH_PRIORITY_CLASS
  • NORMAL_PRIORITY_CLASS
  • IDLE_PRIORITY_CLASS

Return value

The SetPriority method returns one of the following values.

Return code Description
S_OK
The operation was successful.
E_INVALIDARG
The arguments are not valid.

Remarks

After setting the priority of a task, call IPersistFile::Save to save the modified task object to disk.

Examples

For more information and an example of how to set the priority of a task, see C/C++ Code Example: Setting Task Priority.

Requirements

   
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

See also

GetPriority

ITask