[apple/xnu.git] / osfmk / man / task_terminate.html

<h2>task_terminate</h2>\r<hr>\r<p>\r<strong>Function</strong> - Terminate the target task and deallocate its resources.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   task_terminate</strong>\r                <strong>(task_t</strong>            <var>task</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<p>\r<dt> <var>task</var> \r<dd>\r[in task send right]\rThe port for the task to be destroyed.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>task_terminate</strong> function kills task and all its\rthreads, if any.  The kernel \rfrees all resources that are in use by the task.  The kernel\rdestroys any port for \rwhich the task holds the receive right.\r<h3>RETURN VALUES</h3>\r<p>\rOnly generic errors apply.\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="task_create.html"><strong>task_create</strong></a>,\r<a href="task_suspend.html"><strong>task_suspend</strong></a>,\r<a href="task_resume.html"><strong>task_resume</strong></a>,\r<a href="thread_terminate.html"><strong>thread_terminate</strong></a>,\r<a href="thread_suspend.html"><strong>thread_suspend</strong></a>.\r