ITask::SetParameters method (mstask.h)

Article
10/13/2021

[[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 sets the command-line parameters for the task.

Syntax

HRESULT SetParameters(
  [in] LPCWSTR pwszParameters
);

Parameters

[in] pwszParameters

A null-terminated string that contains task parameters. These parameters are passed as command-line arguments to the application the task will run. To clear the command-line parameter property, set pwszParameters to L"".

Return value

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

If the task has an application associated with it, the task parameters that are set by this method are ignored.

After setting the parameters of the task, be sure to call IPersistFile::Save to save the modified task object to disk.

Examples

For an example of how to set parameters, see C/C++ Code Example: Setting Task Parameters.

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