ITaskTrigger::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.] ]
The GetTrigger method retrieves the current task trigger.
Syntax
HRESULT GetTrigger(
[out] PTASK_TRIGGER pTrigger
);
Parameters
[out] pTrigger
A pointer to a TASK_TRIGGER structure that contains the current task trigger. You must set the cbTriggerSize member of the TASK_TRIGGER structure to the size of the task trigger structure before passing the structure to this method.
Return value
The GetTrigger method returns one of the following values.
| Return code | Description |
|---|---|
|
The operation was successful. |
|
The pTrigger parameter is not valid. |
|
Not enough memory is available. |
Remarks
A scheduled work item can have one or more triggers defined. The times that the work item will run are the union of all the triggers defined for that item.
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 |