]> git.saurik.com Git - apple/xnu.git/blobdiff - osfmk/man/mach_port_move_member.html
xnu-792.6.76.tar.gz
[apple/xnu.git] / osfmk / man / mach_port_move_member.html
index c212483291a15a2038417119483db74f77446a7c..2429a86324e253d9be0fadfe0239f25d7a628127 100755 (executable)
@@ -1 +1,95 @@
-<!doctype html public "-//w3c//dtd html 4.0 transitional//en">\r<html>\r<head>\r   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">\r   <meta name="GENERATOR" content="Mozilla/4.73 (Macintosh; U; PPC) [Netscape]">\r   <title>mach_port_insert_member.html</title>\r</head>\r<body>\r\r<h2>\rmach_port_move_member</h2>\r\r<hr>\r<p><b>Function</b> - Move the specified receive right into or out of the\rspecified port set.\r<h3>\rSYNOPSIS</h3>\r\r<pre><b>kern_return_t&nbsp;&nbsp; mach_port_move_member\r</b>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <b>(ipc_space_t</b>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <i>task</i>,\r&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <b>mach_port_name_t</b>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <i>member</i>,\r&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <b>mach_port_name_t</b>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <i>after</i><b>);</b></pre>\r\r<h3>\rPARAMETERS</h3>\r\r<dl>\r<dt>\r<i>task</i></dt>\r\r<dd>\r[in task send right] The task holding the port set and receive right.</dd>\r\r<dt>\r<i>member</i></dt>\r\r<dd>\r[in scalar] The task's name for the receive right.</dd>\r\r<dt>\r<i>after</i></dt>\r\r<dd>\r[in scalar] The task's name for the port set.</dd>\r</dl>\r\r<h3>\rDESCRIPTION</h3>\rThe <b>mach_port_move_member</b> function moves a receive right into a\rport set. If the receive right is already a member of any other port sets,\rit is removed from those sets first. If the port set is <b>MACH_PORT_NULL</b>,\rthen the receive right is not put into a port set, but removed from all\rits current port sets.\r<h3>\rNOTES</h3>\rThis interface is machine word length specific because of the port name\rparameter.\r<h3>\rRETURN VALUES</h3>\r\r<dl>\r<dt>\r<b>KERN_INVALID_NAME</b></dt>\r\r<dd>\r<i>member</i> or <i>after</i> did not denote a right.</dd>\r\r<dt>\r<b>KERN_INVALID_RIGHT</b></dt>\r\r<dd>\r<i>member</i> denoted a right, but not a receive right, or <i>after</i>\rdenoted a right, but not a port set.</dd>\r\r<dt>\r<b>KERN_NOT_IN_SET</b></dt>\r\r<dd>\r<i>after</i> was <b>MACH_PORT_NULL</b>, but <i>member</i> wasn't currently\rin a port set.</dd>\r</dl>\r\r<h3>\rRELATED INFORMATION</h3>\r\r<p>\rFunctions:\r<b><a href="../HTML/mach_port_insert_member.html">mach_port_insert_member</a></b>, \r<b><a href="../HTML/mach_port_extract_member.html">mach_port_extract_member</b></a>, \r<b><a href="../HTML/mach_port_get_set_status.html">mach_port_get_set_status</a></b>,\r<b><a href="../HTML/mach_port_get_attributes.html">mach_port_get_attributes</a></b>.\r</p>\r\r</body>\r</html>\r
\ No newline at end of file
+<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
+<html>
+<head>
+   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+   <meta name="GENERATOR" content="Mozilla/4.73 (Macintosh; U; PPC) [Netscape]">
+   <title>mach_port_insert_member.html</title>
+</head>
+<body>
+
+<h2>
+mach_port_move_member</h2>
+
+<hr>
+<p><b>Function</b> - Move the specified receive right into or out of the
+specified port set.
+<h3>
+SYNOPSIS</h3>
+
+<pre><b>kern_return_t&nbsp;&nbsp; mach_port_move_member
+</b>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <b>(ipc_space_t</b>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <i>task</i>,
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <b>mach_port_name_t</b>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <i>member</i>,
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <b>mach_port_name_t</b>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <i>after</i><b>);</b></pre>
+
+<h3>
+PARAMETERS</h3>
+
+<dl>
+<dt>
+<i>task</i></dt>
+
+<dd>
+[in task send right] The task holding the port set and receive right.</dd>
+
+<dt>
+<i>member</i></dt>
+
+<dd>
+[in scalar] The task's name for the receive right.</dd>
+
+<dt>
+<i>after</i></dt>
+
+<dd>
+[in scalar] The task's name for the port set.</dd>
+</dl>
+
+<h3>
+DESCRIPTION</h3>
+The <b>mach_port_move_member</b> function moves a receive right into a
+port set. If the receive right is already a member of any other port sets,
+it is removed from those sets first. If the port set is <b>MACH_PORT_NULL</b>,
+then the receive right is not put into a port set, but removed from all
+its current port sets.
+<h3>
+NOTES</h3>
+This interface is machine word length specific because of the port name
+parameter.
+<h3>
+RETURN VALUES</h3>
+
+<dl>
+<dt>
+<b>KERN_INVALID_NAME</b></dt>
+
+<dd>
+<i>member</i> or <i>after</i> did not denote a right.</dd>
+
+<dt>
+<b>KERN_INVALID_RIGHT</b></dt>
+
+<dd>
+<i>member</i> denoted a right, but not a receive right, or <i>after</i>
+denoted a right, but not a port set.</dd>
+
+<dt>
+<b>KERN_NOT_IN_SET</b></dt>
+
+<dd>
+<i>after</i> was <b>MACH_PORT_NULL</b>, but <i>member</i> wasn't currently
+in a port set.</dd>
+</dl>
+
+<h3>
+RELATED INFORMATION</h3>
+
+<p>
+Functions:
+<b><a href="../HTML/mach_port_insert_member.html">mach_port_insert_member</a></b>, 
+<b><a href="../HTML/mach_port_extract_member.html">mach_port_extract_member</b></a>, 
+<b><a href="../HTML/mach_port_get_set_status.html">mach_port_get_set_status</a></b>,
+<b><a href="../HTML/mach_port_get_attributes.html">mach_port_get_attributes</a></b>.
+</p>
+
+</body>
+</html>