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

<h2>task_set_security_token</h2>\r<hr>\r<p>\r<strong>Function</strong> - Change the target task's security token.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   task_set_security_token</strong>\r                <strong>(task_t</strong>                                    <var>task</var>,\r                 <strong>security_port_t</strong>                  <var>host_security</var>,\r                 <strong>security_token_t</strong>                <var>security_token</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<p>\r<dt><var>task</var>\r<dd>\r[in task send right] The port for the task for which the token is to be set.\r<p>\r<dt><var>host_security</var>\r<dd>\r[in security send right] The host's security port.\r<p>\r<dt><var>security_token</var>\r<dd>\r[in scalar] The new security token.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>task_set_security_token</strong> function changes the\rspecified task's security token; the new token will be\rincluded in all subsequent messages sent from the task. The\rinitial value of a task's security token is that of its parent.\r<h3>NOTES</h3>\r<p>\rThe host security port is a privileged port given to the system\rbootstrap task for the use of this call.\r<h3>RETURN VALUES</h3>\r<dl>\r<p>\r<dt> <strong>KERN_INVALID_SECURITY</strong>\r<dd>\rThe value of <var>host_security</var> does not specify the security port for the host on which task lies.\r</dl>\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="task_create.html"><strong>task_create</strong></a>,\r<a href="task_info.html"><strong>task_info</strong></a>,\r<a href="mach_msg.html"><strong>mach_msg</strong></a>.\r