IScheduledWorkItem::Terminate 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 ends the execution of the work item.
Syntax
HRESULT Terminate();
Return value
The Terminate method returns one of the following values.
Return code | Description |
---|---|
|
The operation was successful. |
|
The arguments are not valid. |
|
Not enough memory is available. |
Remarks
The Terminate method operates asynchronously. It does not wait for the task to terminate before returning a return value.
If the WM_CLOSE message cannot be sent (for example, the application has no windows) or the application has not exited within three minutes of the receiving WM_CLOSE, the Task Scheduler terminates the application using TerminateProcess.
Examples
For an example of how to retrieve the task status and terminate a task, see Terminating a Task Example.
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 |