X-Git-Url: https://git.saurik.com/apple/xnu.git/blobdiff_plain/743b15655a24ee3fe9f458f383003e011db0558f..13fec9890cf095cc781fdf7b8917cb03bf32dd4c:/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
index 9b3f9c183..59792bdd8 100755
--- 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>
<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>.
\ 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>.