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

<h2>norma_task_create</h2>\r<hr>\r<p>\r<strong>Function</strong> - Create a remote task using task_create semantics.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   norma_task_create</strong>\r                <strong>(task_t</strong>                             <var>parent_task</var>,\r                 <strong>boolean_t</strong>                       <var>inherit_memory</var>,\r                 <strong>int</strong>                                 <var>child_node</var>,\r                 <strong>task_t</strong>                              <var>child_task</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 from which to draw the child \rtask's port rights, resource limits, and address space.\r<p>\r<dt> <var>inherit_memory</var> \r<dd>\r[in scalar]\rAddress space inheritance indicator.  If true, the child task\rinherits the address space of the parent task.  If false, the kernel assigns \rthe child task an empty address space.\r<p>\r<dt> <var>child_node</var> \r<dd>\r[in scalar]\rThe node index of the node on which to create the child.\r<p>\r<dt> <var>child_task</var> \r<dd>\r[out task send right]\rThe kernel-assigned port name for the new task.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>norma_task_create</strong> function creates a new task from\r<var>parent_task</var> on the specified <var>node</var> and returns the name of the \rnew task in <var>child_task</var>.  The child \rtask acquires shared or copied parts of the parent's address space (see\r<strong>vm_inherit</strong>).  The child task initially contains no threads.\r<p>\rBy way of comparison, tasks created by the standard <strong>task_create</strong>\rprimitive are created on the same node as the parent.\r<p>\rOther than being created on a different node, the new task has the same\rproperties as if created by <strong>task_create</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="norma_task_clone.html"><strong>norma_task_clone</strong></a>.\r