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

<h2>mach_port_get_attributes</h2>\r<hr>\r<p>\r<strong>Function</strong> - Return information about target port as specified by the caller.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   mach_port_get_attributes</strong>\r                <strong>(ipc_space_t</strong>                               <var>task</var>,\r                 <strong>mach_port_name_t</strong>                          <var>name</var>,\r                 <strong>mach_port_flavor_t</strong>                      <var>flavor</var>,\r                 <strong>mach_port_info_t</strong>                     <var>port_info</var>,\r                 <strong>mach_msg_type_number_t</strong>        <var>*port_info_count</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 a receive right to the port in\rquestion.\r<p>\r<dt> <var>name</var> \r<dd>\r[in scalar]\r<var>task</var>'s name for the port.\r<p>\r<dt> <var>flavor</var> \r<dd>\r[in scalar]\rThe type of information to be returned.  Valid values are:\r<dl>\r<p>\r<dt> <strong>MACH_PORT_LIMITS_INFO</strong>\r<dd>\rReturns the resource limits for the port.  The declaration of \rthis data is found in structure <strong>mach_port_limits</strong>.\r<p>\r<dt> <strong>MACH_PORT_RECEIVE_STATUS</strong>\r<dd>\rReturns random information about the rights and messages\rassociated with the port.  The declaration of this data is found in \rstructure <strong>mach_port_status</strong>.\r</dl>\r<p>\r<dt> <var>port_info</var> \r<dd>\r[out structure]\rInformation about the specified port.\r<p>\r<dt> <var>port_info_count</var> \r<dd>\r[in/out scalar]\rOn input, the maximum size of the buffer; on output, the \rsize returned (in natural-sized units).\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>mach_port_get_attributes</strong> function returns an information\rstructure of type <var>flavor</var>.\r<h3>NOTES</h3>\r<p>\rThis interface is machine word length specific because of the port name\rparameter in the <strong>MACH_PORT_RECEIVE_STATUS</strong> structure return.\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<p>\r<dt> <strong>KERN_INVALID_RIGHT</strong>\r<dd>\r<var>name</var> denoted a right, but not a receive right.\r</dl>\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="mach_port_allocate.html"><strong>mach_port_allocate</strong></a>,\r<a href="mach_port_allocate_name.html"><strong>mach_port_allocate_name</strong></a>,\r<a href="mach_port_set_attributes.html"><strong>mach_port_set_attributes</strong></a>.\r<p>\rData Structures:\r<a href="mach_port_limits.html"><strong>mach_port_limits</strong></a>,\r<a href="mach_port_status.html"><strong>mach_port_status</strong></a>.\r