Edit

IShellTaskScheduler::RemoveTasks method (shobjidl_core.h)

  • Article

Removes tasks from the scheduler's background queue.

Syntax

HRESULT RemoveTasks(
  [in] REFTASKOWNERID rtoid,
  [in] DWORD_PTR      lParam,
  [in] BOOL           bWaitIfRunning
);

Parameters

[in] rtoid

Type: REFTASKOWNERID

A GUID identifying the owner of the tasks to remove.

[in] lParam

Type: DWORD_PTR

A pointer to a user-defined DWORD value that allows the task to be identified within the tasks owned by rtoid. Set this value to 0 to remove all tasks for the owner specified by rtoid.

[in] bWaitIfRunning

Type: BOOL

TRUE if you want a currently running task to complete before removing it, FALSE otherwise.

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 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header shobjidl_core.h (include Shobjidl.h)
DLL Shell32.dll (version 5.0 or later)