[apple/xnu.git] / osfmk / man / mach_port_extract_member.html

<!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&nbsp;&nbsp; mach_port_extract_member\r</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>,\r&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>,\r&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>\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.&nbsp; 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