xnu-1504.3.12.tar.gz

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

<h2>mach_port_set_mscount</h2>
<hr>
<p>
<strong>Function</strong> - Change the target port's make-send count.
<h3>SYNOPSIS</h3>
<pre>
<strong>kern_return_t   mach_port_set_mscount</strong>
                <strong>(ipc_space_t</strong>                               <var>task</var>,
                 <strong>mach_port_name_t</strong>                          <var>name</var>,
                 <strong>mach_port_mscount_t</strong>                    <var>mscount</var><strong>);</strong>
</pre>
<h3>PARAMETERS</h3>
<dl>
<p>
<dt> <var>task</var> 
<dd>
[in task send right]
The task owning the receive right.
<p>
<dt> <var>name</var> 
<dd>
[in scalar]
<var>task</var>'s name for the receive right.
<p>
<dt> <var>mscount</var> 
<dd>
[in scalar]
New value for the make-send count for the receive right.
</dl>
<h3>DESCRIPTION</h3>
<p>
The <strong>mach_port_set_mscount</strong> function changes the make-send
count of <var>task</var>'s 
receive right named <var>name</var>.
A port's make-send count specifies the number of send rights that have
been generated via the port's receive right.  A port's make-send count
is set to zero when the port is first allocated; the count is reset to
zero each time the port's receive right is transferred via a Mach message. 
<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_get_attributes.html"><strong>mach_port_get_attributes</strong></a>.