IScheduledWorkItem::SetWorkItemData 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.] ]
This method stores application-defined data associated with the work item.
Syntax
HRESULT SetWorkItemData(
[in] WORD cbData,
[in] BYTE [] rgbData
);
Parameters
[in] cbData
The number of bytes in the data buffer. The caller allocates and frees this memory.
[in] rgbData
The data to copy.
Return value
The SetWorkItemData method returns one of the following values.
Return code | Description |
---|---|
|
The operation was successful. |
|
The arguments are not valid. |
|
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
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 |