Edit

ITaskService::GetFolder method (taskschd.h)

  • Article

Gets a folder of registered tasks.

Syntax

HRESULT GetFolder(
  [in]  BSTR        path,
  [out] ITaskFolder **ppFolder
);

Parameters

[in] path

The path to the folder to retrieve. Do not use a backslash following the last folder name in the path. The root task folder is specified with a backslash (\). An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path.

[out] ppFolder

An ITaskFolder interface for the requested folder.

Pass in a reference to a NULL ITaskFolder interface pointer. Referencing a non-NULL pointer can cause a memory leak because the pointer will be overwritten.

Return value

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

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header taskschd.h
Library Taskschd.lib
DLL Taskschd.dll

See also

ITaskService

Task Scheduler