| | 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_move_member</h2> |
| | 12 | |
| | 13 | <hr> |
| | 14 | <p><b>Function</b> - Move the specified receive right into or out of the |
| | 15 | specified port set. |
| | 16 | <h3> |
| | 17 | SYNOPSIS</h3> |
| | 18 | |
| | 19 | <pre><b>kern_return_t mach_port_move_member |
| | 20 | </b> <b>(ipc_space_t</b> <i>task</i>, |
| | 21 | <b>mach_port_name_t</b> <i>member</i>, |
| | 22 | <b>mach_port_name_t</b> <i>after</i><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>after</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_move_member</b> function moves a receive right into a |
| | 50 | port set. If the receive right is already a member of any other port sets, |
| | 51 | it is removed from those sets first. If the port set is <b>MACH_PORT_NULL</b>, |
| | 52 | then the receive right is not put into a port set, but removed from all |
| | 53 | its current port sets. |
| | 54 | <h3> |
| | 55 | NOTES</h3> |
| | 56 | This interface is machine word length specific because of the port name |
| | 57 | parameter. |
| | 58 | <h3> |
| | 59 | RETURN VALUES</h3> |
| | 60 | |
| | 61 | <dl> |
| | 62 | <dt> |
| | 63 | <b>KERN_INVALID_NAME</b></dt> |
| | 64 | |
| | 65 | <dd> |
| | 66 | <i>member</i> or <i>after</i> did not denote a right.</dd> |
| | 67 | |
| | 68 | <dt> |
| | 69 | <b>KERN_INVALID_RIGHT</b></dt> |
| | 70 | |
| | 71 | <dd> |
| | 72 | <i>member</i> denoted a right, but not a receive right, or <i>after</i> |
| | 73 | denoted a right, but not a port set.</dd> |
| | 74 | |
| | 75 | <dt> |
| | 76 | <b>KERN_NOT_IN_SET</b></dt> |
| | 77 | |
| | 78 | <dd> |
| | 79 | <i>after</i> was <b>MACH_PORT_NULL</b>, but <i>member</i> wasn't currently |
| | 80 | in a port set.</dd> |
| | 81 | </dl> |
| | 82 | |
| | 83 | <h3> |
| | 84 | RELATED INFORMATION</h3> |
| | 85 | |
| | 86 | <p> |
| | 87 | Functions: |
| | 88 | <b><a href="../HTML/mach_port_insert_member.html">mach_port_insert_member</a></b>, |
| | 89 | <b><a href="../HTML/mach_port_extract_member.html">mach_port_extract_member</b></a>, |
| | 90 | <b><a href="../HTML/mach_port_get_set_status.html">mach_port_get_set_status</a></b>, |
| | 91 | <b><a href="../HTML/mach_port_get_attributes.html">mach_port_get_attributes</a></b>. |
| | 92 | </p> |
| | 93 | |
| | 94 | </body> |
| | 95 | </html> |
projects / apple / xnu.git / blame_incremental