osfmk/man/task_assign_default.html

   1 <h2>task_assign_default</h2>
   2 <hr>
   3 <p>
   4 <strong>Function</strong> - Assign a task to the default processor set.
   5 <h3>SYNOPSIS</h3>
   6 <pre>
   7 <strong>kern_return_t   task_assign_default</strong>
   8                 <strong>(task_t</strong>                                    <var>task</var>,
   9                  <strong>boolean_t</strong>                       <var>assign_threads</var><strong>);</strong>
  10 </pre>
  11 <h3>PARAMETERS</h3>
  12 <dl>
  13 <dt> <var>task</var>
  14 <dd>
  15 [in task send right]
  16 The port for the task to be assigned.
  17 <dt> <var>assign_threads</var>
  18 <dd>
  19 [in scalar]
  20 True if this assignment should apply as well to the threads
  21 within the task.
  22 </dl>
  23 <h3>DESCRIPTION</h3>
  24 <p>
  25 The <strong>task_assign_default</strong> function assigns <var>task</var> to the
  26 default processor set.
  27 After the assignment is completed, newly created threads within
  28 this task will be
  29 assigned to this processor set.  Any previous assignment of the
  30 task is nullified.
  31 <p>
  32 If <var>assign_threads</var> is <strong>TRUE</strong>, existing threads within the
  33 task will also be assigned to the processor set.
  34 <h3>NOTES</h3>
  35 <p>
  36 This variant of <strong>task_assign</strong> exists because the control
  37 port for the default
  38 processor set is privileged, and therefore not available to most tasks.
  39 <h3>RETURN VALUES</h3>
  40 <p>
  41 Only generic errors apply.
  42 <h3>RELATED INFORMATION</h3>
  43 <p>
  44 Functions:
  45 <a href="task_assign.html"><strong>task_assign</strong></a>,
  46 <a href="task_get_assignment.html"><strong>task_get_assignment</strong></a>,
  47 <a href="processor_set_create.html"><strong>processor_set_create</strong></a>,
  48 <a href="processor_set_info.html"><strong>processor_set_info</strong></a>,
  49 <a href="thread_assign.html"><strong>thread_assign</strong></a>.