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

<h2>etap_trace_thread</h2>\r<hr>\r<p>\r<strong>Function</strong> - Set a thread's ETAP trace status.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>#include&ltmach/etap.h&gt</strong>\r\r<strong>kern_return_t   etap_trace_thread</strong>\r                <strong>(thread_act_t</strong>                     <var>target_thread</var>,\r                 <strong>boolean_t</strong>                               <var>active</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<p>\r<dt> <var>target_thread</var>\r<dd>\rThe port of the thread who's ETAP trace status will be toggled.\r<p>\r<dt> <var>active</var>\r<dd>\rThe boolean value (either TRUE or FALSE) stating whether the thread's\rETAP trace status will be activated or not. Passing TRUE will enable\rthe thread's trace status and FALSE will deactivate it.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>etap_trace_thread</strong> system call is used to\rtoggle the ETAP trace status of a thread.	\r<h3>RETURN VALUES</h3>\r<dl>\r  <dt> <strong>KERN_SUCCESS</strong>\r       <dd>\r	    The call was performed successfully.\r<p>\r  <dt> <strong>KERN_INVALID_ARGUMENT</strong>\r       <dd>\r	    The value of <var>target_thread</var> does not name a valid thread.\r<p>\r  <dt> <strong>KERN_FAILURE</strong>\r       <dd>\r	    ETAP is not configured in the kernel.\r</dl>\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="etap_probe.html"><strong>etap_probe</strong></a>,\r<a href="etap_trace_event.html"><strong>etap_trace_event</strong></a>,\r<a href="etap_get_info.html"><strong>etap_get_info</strong></a>.\r