osfmk/man/mach_port_extract_member.html

   1 <!doctype html public "-//w3c//dtd html 4.0 transitional//en">
   2 <html>
   3 <head>
   4    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
   5    <meta name="GENERATOR" content="Mozilla/4.73 (Macintosh; U; PPC) [Netscape]">
   6    <title>mach_port_insert_member.html</title>
   7 </head>
   8 <body>
   9
  10 <h2>
  11 mach_port_extract_member</h2>
  12
  13 <hr>
  14 <p><b>Function</b> - Extract the specified receive right from the specified
  15 port set.
  16 <h3>
  17 SYNOPSIS</h3>
  18
  19 <pre><b>kern_return_t&nbsp;&nbsp; mach_port_extract_member
  20 </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>,
  21 &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>,
  22 &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>
  23
  24 <h3>
  25 PARAMETERS</h3>
  26
  27 <dl>
  28 <dt>
  29 <i>task</i></dt>
  30
  31 <dd>
  32 [in task send right] The task holding the port set and receive right.</dd>
  33
  34 <dt>
  35 <i>member</i></dt>
  36
  37 <dd>
  38 [in scalar] The task's name for the receive right.</dd>
  39
  40 <dt>
  41 <i>set</i></dt>
  42
  43 <dd>
  44 [in scalar] The task's name for the port set.</dd>
  45 </dl>
  46
  47 <h3>
  48 DESCRIPTION</h3>
  49 The <b>mach_port_extract_member</b> function removes a receive right from
  50 a port set. Any other port set memberships for the receive right are not
  51 affected.&nbsp; A receive right can be a member of any number of portsets
  52 simultaneously.
  53 <h3>
  54 NOTES</h3>
  55 This interface is machine word length specific because of the port name
  56 parameter.
  57 <h3>
  58 RETURN VALUES</h3>
  59
  60 <dl>
  61 <dt>
  62 <b>KERN_INVALID_NAME</b></dt>
  63
  64 <dd>
  65 <i>member</i> or <i>set</i> did not denote a right.</dd>
  66
  67 <dt>
  68 <b>KERN_INVALID_RIGHT</b></dt>
  69
  70 <dd>
  71 <i>member</i> denoted a right, but not a receive right, or <i>set</i> denoted
  72 a right, but not a port set.</dd>
  73
  74 <dt>
  75 <b>KERN_NOT_IN_SET</b></dt>
  76
  77 <dd>
  78 <i>member</i> was not in <i>set</i>.</dd>
  79 </dl>
  80
  81 <h3>
  82 RELATED INFORMATION</h3>
  83 Functions:
  84 <b><a href="../HTML/mach_port_extract_member.html">mach_port_extract_member</a></b>,
  85 <b><a href="../HTML/mach_port_move_member.html">mach_port_move_member</a></b>,
  86 <b><a href="../HTML/mach_port_get_set_status.html">mach_port_get_set_status</a></b>,
  87 <b><a href="../HTML/mach_port_get_attributes.html">mach_port_get_attributes</a></b>.
  88 </body>
  89 </html>