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

<H2>task_set_info</h2>\r<hr>\r<p>\r<strong>Function</strong> - Set task-specific information state.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>#include&lttask_info.h&gt</strong>\r\r<strong>kern_return_t   task_set_info</strong>\r                <strong>(task_t</strong>                             <var>target_task</var>,\r                 <strong>task_flavor_t</strong>                           <var>flavor</var>,\r                 <strong>task_info_t</strong>                          <var>task_info</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<p>\r<dt> <var>target_task</var> \r<dd>\rThe task whose information is to be set.\r<p>\r<dt> <var>flavor</var> \r<dd>\rSpecifies the type of information to be set.  Currently the interface\rsupports the setting of a single flavor:\r<strong>TASK_USER_DATA</strong>.\r<p>\r<dt> <var>task_info</var> \r<dd>\rSpecifies the information to be set.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>task_set_info</strong> interface provides the caller with\rthe means to set the target task's <var>user_data</var> field. This\rfield may be used to specify arbitrarily task-specific data.\r<h3>NOTES</h3>\r<p>\rCurrently, this interface is used exclusively to provide freshly\rcolocated user tasks with the short-circuited RPC glue vector.\r<h3>RETURN VALUES</h3>\r<p>\rOnly generic values apply.\r<h3>RELATED INFORMATION</h3>\r<p>\r