xnu-2422.1.72.tar.gz

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

diff --git a/osfmk/man/mach_port_get_set_status.html b/osfmk/man/mach_port_get_set_status.html
old mode 100755 (executable)
new mode 100644 (file)
index 3860a76..b5f9a28
--- a/osfmk/man/mach_port_get_set_status.html
+++ b/osfmk/man/mach_port_get_set_status.html
@@ -1 +1,71 @@
-<h2>mach_port_get_set_status</h2>\r<hr>\r<p>\r<strong>Function</strong> - Return the port right names contained in the target port set.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   mach_port_get_set_status</strong>\r                <strong>(ipc_space_t</strong>                               <var>task</var>,\r                 <strong>mach_port_name_t</strong>                          <var>name</var>,\r                 <strong>mach_port_name_array_t</strong>                <var>*members</var>,\r                 <strong>task</strong>                                     <var>count</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 holding the port set.\r<p>\r<dt> <var>name</var> \r<dd>\r[in scalar]\rThe task's name for the port set.\r<p>\r<dt> <var>members</var> \r<dd>\r[out pointer to dynamic array of <var>mach_port_name_t</var>]\rThe task's names \rfor the port set's members.\r<p>\r<dt> <var>count</var> \r<dd>\r[out scalar]\rThe number of member names returned.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>mach_port_get_set_status</strong> function returns the individual port \rright names for all port rights contained in the specified port set.\rThe <var>members</var> parameter is an array that is automatically \rallocated when the reply message is received.  Note that\r<strong>vm_deallocate</strong> should be used to free the array.\r<p>\rNote that this interface, unlike others such as <strong>task_threads</strong>,\rreturns a collection of port right names, NOT a collection of port rights themselves.\rIn other words, this function does not insert port rights into the caller's\rport right name space; consequently, a call to  <strong>mach_port_get_set_status</strong>\rdoes not affect the reference count of each port right within the target port set.\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<dl>\r<p>\r<dt> <strong>KERN_INVALID_NAME</strong>\r<dd>\r<var>name</var> did not denote a right.\r<p>\r<dt> <strong>KERN_INVALID_RIGHT</strong>\r<dd>\r<var>name</var> denoted a right, but not a port set.\r</dl>\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="mach_port_insert_member.html"><strong>mach_port_insert_member</strong></a>,\r<a href="mach_port_extract_member.html"><strong>mach_port_extract_member</strong></a>,\r<a href="mach_port_move_member.html"><strong>mach_port_move_member</strong></a>,\r<a href="vm_deallocate.html"><strong>vm_deallocate</strong></a>.\r
\ No newline at end of file
+<h2>mach_port_get_set_status</h2>
+<hr>
+<p>
+<strong>Function</strong> - Return the port right names contained in the target port set.
+<h3>SYNOPSIS</h3>
+<pre>
+<strong>kern_return_t   mach_port_get_set_status</strong>
+                <strong>(ipc_space_t</strong>                               <var>task</var>,
+                 <strong>mach_port_name_t</strong>                          <var>name</var>,
+                 <strong>mach_port_name_array_t</strong>                <var>*members</var>,
+                 <strong>task</strong>                                     <var>count</var><strong>);</strong>
+</pre>
+<h3>PARAMETERS</h3>
+<dl>
+<p>
+<dt> <var>task</var> 
+<dd>
+[in task send right]
+The task holding the port set.
+<p>
+<dt> <var>name</var> 
+<dd>
+[in scalar]
+The task's name for the port set.
+<p>
+<dt> <var>members</var> 
+<dd>
+[out pointer to dynamic array of <var>mach_port_name_t</var>]
+The task's names 
+for the port set's members.
+<p>
+<dt> <var>count</var> 
+<dd>
+[out scalar]
+The number of member names returned.
+</dl>
+<h3>DESCRIPTION</h3>
+<p>
+The <strong>mach_port_get_set_status</strong> function returns the individual port 
+right names for all port rights contained in the specified port set.
+The <var>members</var> parameter is an array that is automatically 
+allocated when the reply message is received.  Note that
+<strong>vm_deallocate</strong> should be used to free the array.
+<p>
+Note that this interface, unlike others such as <strong>task_threads</strong>,
+returns a collection of port right names, NOT a collection of port rights themselves.
+In other words, this function does not insert port rights into the caller's
+port right name space; consequently, a call to  <strong>mach_port_get_set_status</strong>
+does not affect the reference count of each port right within the target port set.
+<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>
+<dl>
+<p>
+<dt> <strong>KERN_INVALID_NAME</strong>
+<dd>
+<var>name</var> did not denote a right.
+<p>
+<dt> <strong>KERN_INVALID_RIGHT</strong>
+<dd>
+<var>name</var> denoted a right, but not a port set.
+</dl>
+<h3>RELATED INFORMATION</h3>
+<p>
+Functions:
+<a href="mach_port_insert_member.html"><strong>mach_port_insert_member</strong></a>,
+<a href="mach_port_extract_member.html"><strong>mach_port_extract_member</strong></a>,
+<a href="mach_port_move_member.html"><strong>mach_port_move_member</strong></a>,
+<a href="vm_deallocate.html"><strong>vm_deallocate</strong></a>.