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

Retrieves a task trigger.

Syntax

HRESULT GetTrigger(
  [in]  WORD         iTrigger,
  [out] ITaskTrigger **ppTrigger
);

Parameters

[in] iTrigger

The index of the trigger to retrieve.

[out] ppTrigger

A pointer to a pointer to an ITaskTrigger interface for the retrieved trigger.

Return value

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

IScheduledWorkItem

ITaskTrigger