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

<h2>thread_set_special_port</h2>\r<hr>\r<p>\r<strong>Function</strong> - Set caller-specified special port belonging to the target thread.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   thread_set_special_port</strong>\r                <strong>(thread_act_t</strong>                            <var>thread</var>,\r                 <strong>int</strong>                                 <var>which_port</var>,\r                 <strong>mach_port_t</strong>                       <var>special_port</var><strong>);</strong>\r</pre>\r\r<h4>Macro form:</h4>\r<pre>\r<strong>kern_return_t   thread_set_kernel_port</strong>\r                <strong>(thread_act_t</strong>                            <var>thread</var>,\r                 <strong>mach_port_t</strong>                       <var>special_port</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<p>\r<dt> <var>thread</var> \r<dd>\r[in thread send right]\rThe thread for which to set the port.\r<p>\r<dt> <var>which_port</var> \r<dd>\r[in scalar]\rThe special port to be set.  Valid values are:\r<dl>\r<p>\r<dt> <strong>THREAD_KERNEL_PORT</strong>\r<dd>\r[thread-self port] The thread's kernel port.  Used by the kernel \rto receive messages from the thread.  This is the port returned \rby <strong>mach_thread_self</strong>.\r</dl>\r<p>\r<dt> <var>special_port</var> \r<dd>\r[in thread-special send right]\rThe value for the port.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>thread_set_special_port</strong> function sets a special\rport belonging to <var>thread</var>.\r<h3>RETURN VALUES</h3>\r<p>\rOnly generic errors apply.\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="mach_thread_self.html"><strong>mach_thread_self</strong></a>,\r<a href="task_get_special_port.html"><strong>task_get_special_port</strong></a>,\r<a href="task_set_special_port.html"><strong>task_set_special_port</strong></a>,\r<a href="thread_create.html"><strong>thread_create</strong></a>,\r<a href="thread_get_special_port.html"><strong>thread_get_special_port</strong></a>.\r