IScheduledWorkItem::SetWorkItemData 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.] ]

This method stores application-defined data associated with the work item.

Syntax

HRESULT SetWorkItemData(
  WORD    cbData,
  BYTE [] rgbData
);

Parameters

cbData

The number of bytes in the data buffer. The caller allocates and frees this memory.

rgbData

The data to copy.

Return Value

The SetWorkItemData method returns one of the following values.

Return code Description
S_OK
The operation was successful.
E_INVALIDARG
The arguments are not valid.
E_OUTOFMEMORY
Not enough memory is available.

Remarks

You can retrieve data by calling IScheduledWorkItem::GetWorkItemData.

Programs must call the IPersistFile::Save method after calling SetWorkItemData to update the work item data.

Requirements

   
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

IScheduledWorkItem

IScheduledWorkItem::GetWorkItemData