-<!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_extract_member</h2>
\r\r<hr>
\r<p><b>Function</b> - Extract the specified receive right from the specified
\rport set.
\r<h3>
\rSYNOPSIS</h3>
\r\r<pre><b>kern_return_t mach_port_extract_member
\r</b> <b>(ipc_space_t</b> <i>task</i>,
\r <b>mach_port_name_t</b> <i>member</i>,
\r <b>mach_port_name_t</b> set<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>set</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_extract_member</b> function removes a receive right from
\ra port set. Any other port set memberships for the receive right are not
\raffected. A receive right can be a member of any number of portsets
\rsimultaneously.
\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>set</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>set</i> denoted
\ra right, but not a port set.</dd>
\r\r<dt>
\r<b>KERN_NOT_IN_SET</b></dt>
\r\r<dd>
\r<i>member</i> was not in <i>set</i>.</dd>
\r</dl>
\r\r<h3>
\rRELATED INFORMATION</h3>
\rFunctions:
\r<b><a href="../HTML/mach_port_extract_member.html">mach_port_extract_member</a></b>,
\r<b><a href="../HTML/mach_port_move_member.html">mach_port_move_member</a></b>,
\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</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_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 mach_port_extract_member
+</b> <b>(ipc_space_t</b> <i>task</i>,
+ <b>mach_port_name_t</b> <i>member</i>,
+ <b>mach_port_name_t</b> 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. 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>
projects / apple / xnu.git / blobdiff