IEnumWorkItems::Clone 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.] ]

Creates a new enumeration object that contains the same enumeration state as the current enumeration.

Because the new object points to the same place in the enumeration sequence, a client can use the Clone method to record a particular point in the enumeration sequence and return to that point later.

Syntax

HRESULT Clone(
  [out] IEnumWorkItems **ppEnumWorkItems
);

Parameters

[out] ppEnumWorkItems

A pointer to a pointer to a new IEnumWorkItems interface. This pointer will point to the newly created enumeration. If the method fails, this parameter is undefined.

Return value

Returns one of the following values.

Return code Description
S_OK
The operation was successful.
E_INVALIDARG
The argument is not valid.
E_OUTOFMEMORY
There is not enough memory available.
E_UNEXPECTED
An error occurred.

Remarks

The IEnumWorkItems interface also provides methods for retrieving sets of tasks, skipping sets of tasks, and resetting the enumeration sequence.

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 mstask.h
Library Mstask.lib
DLL Mstask.dll
Redistributable Internet Explorer 4.0 or later on Windows NT 4.0 and Windows 95

See also

IEnumWorkItems

IEnumWorkItems::Next

IEnumWorkItems::Reset

IEnumWorkItems::Skip