osfmk/man/mach_port_move_member.html

   1 <!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>