xnu-2422.1.72.tar.gz

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

diff --git a/osfmk/man/mach_port_set_attributes.html b/osfmk/man/mach_port_set_attributes.html
old mode 100755 (executable)
new mode 100644 (file)
index 9b3f9c1..59792bd
--- a/osfmk/man/mach_port_set_attributes.html
+++ b/osfmk/man/mach_port_set_attributes.html
@@ -1 +1,78 @@
-<h2>mach_port_set_attributes</h2>\r<hr>\r<p>\r<strong>Function</strong> - Set the target port's attributes.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   mach_port_set_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 attributes to be set.  Valid values are:\r<dl>\r<p>\r<dt> <strong>MACH_PORT_LIMITS_INFO</strong>\r<dd>\rSets resource limits (queue limits) for the port.  The declaration \rof this data is found in structure <strong>mach_port_limits</strong>.\r</dl>\r<p>\r<dt> <var>port_info</var> \r<dd>\r[pointer to in structure]\rAttributes for the specified port.\r<p>\r<dt> <var>port_info_count</var> \r<dd>\r[in scalar]\rThe size of the buffer (in natural-sized units).\r</dl>\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>mach_port_set_attributes</strong> function sets attributes of type \r<var>flavor</var>.\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<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_get_attributes.html"><strong>mach_port_get_attributes</strong></a>.\r<p>\rData Structures:\r<a href="mach_port_limits.html"><strong>mach_port_limits</strong></a>.\r
\ No newline at end of file
+<h2>mach_port_set_attributes</h2>
+<hr>
+<p>
+<strong>Function</strong> - Set the target port's attributes.
+<h3>SYNOPSIS</h3>
+<pre>
+<strong>kern_return_t   mach_port_set_attributes</strong>
+                <strong>(ipc_space_t</strong>                               <var>task</var>,
+                 <strong>mach_port_name_t</strong>                          <var>name</var>,
+                 <strong>mach_port_flavor_t</strong>                      <var>flavor</var>,
+                 <strong>mach_port_info_t</strong>                     <var>port_info</var>,
+                 <strong>mach_msg_type_number_t</strong>         <var>port_info_count</var><strong>);</strong>
+</pre>
+<h3>PARAMETERS</h3>
+<dl>
+<p>
+<dt> <var>task</var> 
+<dd>
+[in task send right]
+The task holding a receive right to the port in
+question.
+<p>
+<dt> <var>name</var> 
+<dd>
+[in scalar]
+<var>task</var>'s name for the port.
+<p>
+<dt> <var>flavor</var> 
+<dd>
+[in scalar]
+The type of attributes to be set.  Valid values are:
+<dl>
+<p>
+<dt> <strong>MACH_PORT_LIMITS_INFO</strong>
+<dd>
+Sets resource limits (queue limits) for the port.  The declaration 
+of this data is found in structure <strong>mach_port_limits</strong>.
+</dl>
+<p>
+<dt> <var>port_info</var> 
+<dd>
+[pointer to in structure]
+Attributes for the specified port.
+<p>
+<dt> <var>port_info_count</var> 
+<dd>
+[in scalar]
+The size of the buffer (in natural-sized units).
+</dl>
+</dl>
+<h3>DESCRIPTION</h3>
+<p>
+The <strong>mach_port_set_attributes</strong> function sets attributes of type 
+<var>flavor</var>.
+<h3>NOTES</h3>
+<p>
+This interface is machine word length specific because of the port name
+parameter.
+<h3>RETURN VALUES</h3>
+<dl>
+<p>
+<dt> <strong>KERN_INVALID_NAME</strong>
+<dd>
+<var>name</var> did not denote a right.
+<p>
+<dt> <strong>KERN_INVALID_RIGHT</strong>
+<dd>
+<var>name</var> denoted a right, but not a receive right.
+</dl>
+<h3>RELATED INFORMATION</h3>
+<p>
+Functions:
+<a href="mach_port_allocate.html"><strong>mach_port_allocate</strong></a>,
+<a href="mach_port_allocate_name.html"><strong>mach_port_allocate_name</strong></a>,
+<a href="mach_port_get_attributes.html"><strong>mach_port_get_attributes</strong></a>.
+<p>
+Data Structures:
+<a href="mach_port_limits.html"><strong>mach_port_limits</strong></a>.