Edit

ITaskTrigger::GetTriggerString method (mstask.h)

  • Article

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

The GetTriggerString method retrieves the current task trigger in the form of a string. This string appears in the Task Scheduler user interface in a form similar to "At 2PM every day, starting 5/11/97."

Syntax

HRESULT GetTriggerString(
  [out] LPWSTR *ppwszTrigger
);

Parameters

[out] ppwszTrigger

A pointer to a pointer to a null-terminated string that describes the current task trigger. The method that invokes GetTriggerString is responsible for freeing this string using the CoTaskMemFree function.

Return value

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

ITaskTrigger

ITaskTrigger::GetTrigger

ITaskTrigger::SetTrigger