ITaskFolder::GetTask method (taskschd.h)

Gets a task at a specified location in a folder.

Syntax

HRESULT GetTask(
  [in]  BSTR            path,
  [out] IRegisteredTask **ppTask
);

Parameters

[in] path

The path (location) to the task in a folder. 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] ppTask

The task at the specified location.

Pass in a reference to a NULL IRegisteredTask 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

ITaskFolder