osfmk/man/mach_port_extract_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_extract_member</h2>

<hr>
<p><b>Function</b> - Extract the specified receive right from the specified
port set.
<h3>
SYNOPSIS</h3>

<pre><b>kern_return_t&nbsp;&nbsp; mach_port_extract_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; set<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>set</i></dt>

<dd>
[in scalar] The task's name for the port set.</dd>
</dl>

<h3>
DESCRIPTION</h3>
The <b>mach_port_extract_member</b> function removes a receive right from
a port set. Any other port set memberships for the receive right are not
affected.&nbsp; A receive right can be a member of any number of portsets
simultaneously.
<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>set</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>set</i> denoted
a right, but not a port set.</dd>

<dt>
<b>KERN_NOT_IN_SET</b></dt>

<dd>
<i>member</i> was not in <i>set</i>.</dd>
</dl>

<h3>
RELATED INFORMATION</h3>
Functions: 
<b><a href="../HTML/mach_port_extract_member.html">mach_port_extract_member</a></b>, 
<b><a href="../HTML/mach_port_move_member.html">mach_port_move_member</a></b>, 
<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>.
</body>
</html>