ITaskTrigger::GetTriggerString 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.] ]

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.

Requirements

See also

ITaskTrigger

ITaskTrigger::GetTrigger

ITaskTrigger::SetTrigger