ITask::GetParameters 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 retrieves the task's command-line parameters.

Syntax

HRESULT GetParameters(
  [out] LPWSTR *ppwszParameters
);

Parameters

[out] ppwszParameters

A pointer to a null-terminated string that contains the command-line parameters for the task. The method that invokes GetParameters is responsible for freeing this string using the CoTaskMemFree function.

Return value

The GetParameters 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.

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

See also

ITask

SetParameters