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

<h2>thread_create_running</h2>\r<hr>\r<p>\r<strong>Function</strong> - Optimized creation of a running thread.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   thread_create_running</strong>\r                <strong>(task_t</strong>                             <var>parent_task</var>,\r                 <strong>thread_state_flavor_t</strong>                   <var>flavor</var>,\r                 <strong>thread_state_t</strong>                           <var>state</var>,\r                 <strong>thread_act_t</strong>                      <var>child_thread</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<p>\r<dt> <var>parent_task</var> \r<dd>\r[in task send right]\rThe port for the task that is to contain the new \rthread.\r<p>\r<dt> <var>flavor</var> \r<dd>\r[in scalar]\rThe type of state to establish.  Valid values correspond to \rsupported machine architecture features.\r<p>\r<dt> <var>state</var> \r<dd>\r[pointer to in structure]\rState information for the specified thread.\r<p>\r<dt> <var>child_thread</var> \r<dd>\r[out thread send right]\rThe kernel-assigned name for the new thread.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>thread_create_running</strong> function creates a new thread\rwithin <var>parent_task</var>. \rThe new thread has is not suspended.  Its initial state is given\rby <var>state</var>.  <var>flavor</var> specifies the type of state to set.\r<p>\rThe format of the state to set is machine specific; it is defined in \r\*L<mach/thread_status.h>\*O.\r<p>\rThe new thread holds a send right for its thread kernel port.\rA send right for the \rthread's kernel port is also returned to the calling task or\rthread in <var>child_thread</var>. \rThe new thread's exception ports are set to <strong>MACH_PORT_NULL</strong>.\r<h3>NOTES</h3>\r<p>\rThis is an optimized form of the sequence: <strong>thread_create</strong>,\r<strong>thread_set_state</strong> \rand <strong>thread_resume</strong>.\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_threads.html"><strong>task_threads</strong></a>,\r<a href="thread_get_special_port.html"><strong>thread_get_special_port</strong></a>,\r<a href="thread_get_state.html"><strong>thread_get_state</strong></a>,\r<a href="thread_resume.html"><strong>thread_resume</strong></a>,\r<a href="thread_set_special_port.html"><strong>thread_set_special_port</strong></a>,\r<a href="thread_set_state.html"><strong>thread_set_state</strong></a>,\r<a href="thread_suspend.html"><strong>thread_suspend</strong></a>,\r<a href="thread_terminate.html"><strong>thread_terminate</strong></a>,\r<a href="thread_create.html"><strong>thread_create</strong></a>.\r