ITaskScheduler::Enum method

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

The Enum method retrieves a pointer to an OLE enumerator object that enumerates the tasks in the current task folder.

Syntax


HRESULT Enum(
  [out] IEnumWorkItems **ppEnumTasks
);

Parameters

ppEnumTasks [out]

A pointer to a pointer to an IEnumWorkItems interface. This interface contains the enumeration context of the current task(s).

Return value

The Enum method returns one of the following values.

Return codeDescription
S_OK

The operation was successful.

E_INVALIDARG

The arguments are not valid.

E_OUTOFMEMORY

Not enough memory is available.

 

Remarks

By default, the current folder resides on the local computer. For remote computers, call ITaskScheduler::GetTargetComputer and use the name returned by this call. To change the target computer call ITaskScheduler::SetTargetComputer.

For a complete example ofSee
Using Enum to retrieve the task names on the local computer Enumerating Tasks Example

 

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Redistributable

Internet Explorer 4.0 or later on Windows NT 4.0 and Windows 95

Header

Mstask.h

Library

Mstask.lib

DLL

Mstask.dll

See also

IEnumWorkItems
ITaskScheduler
ITaskScheduler::GetTargetComputer
ITaskScheduler::SetTargetComputer

 

 

Show: