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

<h2>mach_port_names</h2>\r<hr>\r<p>\r<strong>Function</strong> - Return information about a task's port name space.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   mach_port_names</strong>\r                <strong>(ipc_space_t</strong>                               <var>task</var>,\r                 <strong>mach_port_name_array_t</strong>                  <var>*names</var>,\r                 <strong>mach_msg_type_number_t</strong>               <var>*namesCnt</var>,\r                 <strong>mach_port_type_array_</strong>                   <var>*types</var>,\r                 <strong>mach_msg_type_number_t</strong>               <var>*typesCnt</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]\rThe task whose port name space is queried.\r<p>\r<dt> <var>names</var> \r<dd>\r[out pointer to dynamic array of <var>mach_port_name_t</var>]\rThe names of the \rports, port sets, and dead names in the task's port name space, in no \rparticular order.\r<p>\r<dt> <var>namesCnt</var> \r<dd>\r[out scalar]\rThe number of names returned.\r<p>\r<dt> <var>types</var> \r<dd>\r[out pointer to dynamic array of <var>mach_port_type_t</var>]\rThe type of each \rcorresponding name.  Indicates what kind of rights the task holds with \rthat name.\r<p>\r<dt> <var>typesCnt</var> \r<dd>\r[out scalar]\rThe number of types returned.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>mach_port_names</strong> returns information about <var>task</var>'s\rport name space.  It\rreturns task's currently active names, which represent some port,\rport set, or dead \rname right.  For each name, it also returns what type of rights\r<var>task</var> holds (the \rsame information returned by <strong>mach_port_type</strong>).\r<p>\rNote that when a call to <strong>mach_port_names</strong> returns, the\rnumber of entries in the two output arrays (<var>names</var> and <var>types</var>)\rare equal (<var>namesCnt</var> equals <var>typesCnt</var>).  The fact that this\rinterface returns two separate counts is an artifact of the Mach Interface Generator.\r<h3>NOTES</h3>\r<p>\rThis interface is machine word length specific because of the port name\rparameter and the returned port names.\r<h3>RETURN VALUES</h3>\r<p>\rOnly generic errors apply.\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="mach_port_type.html"><strong>mach_port_type</strong></a>.\r