xnu-792.6.76.tar.gz

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

diff --git a/osfmk/man/mach_port_names.html b/osfmk/man/mach_port_names.html
index daf43359af8d0d49b5d764c641b9131231cd43fd..2739ccbfe675bc12d5fae0c6e323608cca4b2bf0 100755 (executable)
--- a/osfmk/man/mach_port_names.html
+++ b/osfmk/man/mach_port_names.html
@@ -1 +1,70 @@
-<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
\ No newline at end of file
+<h2>mach_port_names</h2>
+<hr>
+<p>
+<strong>Function</strong> - Return information about a task's port name space.
+<h3>SYNOPSIS</h3>
+<pre>
+<strong>kern_return_t   mach_port_names</strong>
+                <strong>(ipc_space_t</strong>                               <var>task</var>,
+                 <strong>mach_port_name_array_t</strong>                  <var>*names</var>,
+                 <strong>mach_msg_type_number_t</strong>               <var>*namesCnt</var>,
+                 <strong>mach_port_type_array_</strong>                   <var>*types</var>,
+                 <strong>mach_msg_type_number_t</strong>               <var>*typesCnt</var><strong>);</strong>
+</pre>
+<h3>PARAMETERS</h3>
+<dl>
+<p>
+<dt> <var>task</var> 
+<dd>
+[in task send right]
+The task whose port name space is queried.
+<p>
+<dt> <var>names</var> 
+<dd>
+[out pointer to dynamic array of <var>mach_port_name_t</var>]
+The names of the 
+ports, port sets, and dead names in the task's port name space, in no 
+particular order.
+<p>
+<dt> <var>namesCnt</var> 
+<dd>
+[out scalar]
+The number of names returned.
+<p>
+<dt> <var>types</var> 
+<dd>
+[out pointer to dynamic array of <var>mach_port_type_t</var>]
+The type of each 
+corresponding name.  Indicates what kind of rights the task holds with 
+that name.
+<p>
+<dt> <var>typesCnt</var> 
+<dd>
+[out scalar]
+The number of types returned.
+</dl>
+<h3>DESCRIPTION</h3>
+<p>
+The <strong>mach_port_names</strong> returns information about <var>task</var>'s
+port name space.  It
+returns task's currently active names, which represent some port,
+port set, or dead 
+name right.  For each name, it also returns what type of rights
+<var>task</var> holds (the 
+same information returned by <strong>mach_port_type</strong>).
+<p>
+Note that when a call to <strong>mach_port_names</strong> returns, the
+number of entries in the two output arrays (<var>names</var> and <var>types</var>)
+are equal (<var>namesCnt</var> equals <var>typesCnt</var>).  The fact that this
+interface returns two separate counts is an artifact of the Mach Interface Generator.
+<h3>NOTES</h3>
+<p>
+This interface is machine word length specific because of the port name
+parameter and the returned port names.
+<h3>RETURN VALUES</h3>
+<p>
+Only generic errors apply.
+<h3>RELATED INFORMATION</h3>
+<p>
+Functions:
+<a href="mach_port_type.html"><strong>mach_port_type</strong></a>.