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

Sets the comment for the work item.

Syntax

HRESULT SetComment(
  [in] LPCWSTR pwszComment
);

Parameters

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

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

See also

IScheduledWorkItem

IScheduledWorkItem::GetComment

ITask