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

Sets the comment for the work item.

Syntax

HRESULT SetComment(
  LPCWSTR pwszComment
);

Parameters

pwszComment

A null-terminated string that specifies the comment for the current work item.

Return Value

The SetComment 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

After setting the comment of a work item, be sure to call IPersistFile::Save to save the modified work item object to disk.

Examples

For an example of how to set the comment of a task, see C/C++ Code Example: Setting Task Comment.

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::GetComment

ITask