]> git.saurik.com Git - apple/xnu.git/blobdiff - osfmk/man/task_assign.html
xnu-344.tar.gz
[apple/xnu.git] / osfmk / man / task_assign.html
diff --git a/osfmk/man/task_assign.html b/osfmk/man/task_assign.html
new file mode 100755 (executable)
index 0000000..f466718
--- /dev/null
@@ -0,0 +1 @@
+<h2>task_assign</h2>\r<hr>\r<p>\r<strong>Function</strong> - Assign a task to a processor set.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   task_assign</strong>\r                <strong>(task_t</strong>                                    <var>task</var>,\r                 <strong>processor_set_t</strong>                  <var>processor_set</var>,\r                 <strong>boolean_t</strong>                       <var>assign_threads</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<dt> <var>task</var> \r<dd>\r[in task send right]\rThe port for the task to be assigned.\r<dt> <var>processor_set</var> \r<dd>\r[in processor-set-control send right]\rThe control port for the processor \rset into which the task is to be assigned.\r<dt> <var>assign_threads</var> \r<dd>\r[in scalar]\rTrue if this assignment should apply as well to the threads \rwithin the task.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>task_assign</strong> function assigns <var>task</var> to the set \r<var>processor_set</var>.\rAfter the assignment is completed, newly created threads within this task\rwill be assigned to \rthis processor set.  Any previous assignment of the task is nullified. \r<p>\rIf <var>assign_threads</var> is <strong>TRUE</strong>, existing threads within the task \rwill also be assigned to the processor set.\r<h3>RETURN VALUES</h3>\r<p>\rOnly generic errors apply.\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="task_assign_default.html"><strong>task_assign_default</strong></a>,\r<a href="task_get_assignment.html"><strong>task_get_assignment</strong></a>,\r<a href="processor_set_create.html"><strong>processor_set_create</strong></a>,\r<a href="processor_set_info.html"><strong>processor_set_info</strong></a>,\r<a href="thread_assign.html"><strong>thread_assign</strong></a>.\r
\ No newline at end of file