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

<h2>mach_port_get_refs</h2>\r<hr>\r<p>\r<strong>Function</strong> - Return the current count of user references on the target port right.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   mach_port_get_refs</strong>\r                <strong>(ipc_space_t</strong>                               <var>task</var>,\r                 <strong>mach_port_name_t</strong>                          <var>name</var>,\r                 <strong>mach_port_right_t</strong>                        <var>right</var>,\r                 <strong>mach_port_urefs_t</strong>                        <var>*refs</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<p>\r<dt> <var>task</var> \r<dd>\r[in task send right]\rThe task holding the right.\r<p>\r<dt> <var>name</var> \r<dd>\r[in scalar]\rThe task's name for the right.\r<p>\r<dt> <var>right</var> \r<dd>\r[in scalar]\rThe type of right/entity being examined:\r<dl>\r<p>\r<dt> <dd>\r<strong>MACH_PORT_RIGHT_SEND</strong>\r<p>\r<dt> <dd>\r<strong>MACH_PORT_RIGHT_RECEIVE</strong>\r<p>\r<dt> <dd>\r<strong>MACH_PORT_RIGHT_SEND_ONCE</strong>\r<p>\r<dt> <dd>\r<strong>MACH_PORT_RIGHT_PORT_SET</strong>\r<p>\r<dt> <dd>\r<strong>MACH_PORT_RIGHT_DEAD_NAME</strong>\r</dl>\r<p>\r<dt> <var>refs</var> \r<dd>\r[out scalar]\rNumber of user references.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>mach_port_get_refs</strong> function returns the number\rof user references a task \rhas for a right.\r<p>\rIf <var>name</var> denotes a right, but not the type of right specified,\rthen zero is returned. \rOtherwise a positive number of user references is returned.  Note a name may\rsimultaneously denote send and receive rights.  The number of references for\rsend-once rights is always one.\r<h3>NOTES</h3>\r<p>\rThis interface is machine word length specific because of the port name\rparameter.\r<h3>RETURN VALUES</h3>\r<dl>\r<p>\r<dt> <strong>KERN_INVALID_NAME</strong>\r<dd>\r<var>name</var> did not denote a right.\r</dl>\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="mach_port_mod_refs.html"><strong>mach_port_mod_refs</strong></a>.\r