xnu-2422.1.72.tar.gz

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

diff --git a/osfmk/man/mach_port_set_mscount.html b/osfmk/man/mach_port_set_mscount.html
old mode 100755 (executable)
new mode 100644 (file)
index d42f8eb..c427702
--- a/osfmk/man/mach_port_set_mscount.html
+++ b/osfmk/man/mach_port_set_mscount.html
@@ -1 +1,57 @@
-<h2>mach_port_set_mscount</h2>\r<hr>\r<p>\r<strong>Function</strong> - Change the target port's make-send count.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   mach_port_set_mscount</strong>\r                <strong>(ipc_space_t</strong>                               <var>task</var>,\r                 <strong>mach_port_name_t</strong>                          <var>name</var>,\r                 <strong>mach_port_mscount_t</strong>                    <var>mscount</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 owning the receive right.\r<p>\r<dt> <var>name</var> \r<dd>\r[in scalar]\r<var>task</var>'s name for the receive right.\r<p>\r<dt> <var>mscount</var> \r<dd>\r[in scalar]\rNew value for the make-send count for the receive right.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>mach_port_set_mscount</strong> function changes the make-send\rcount of <var>task</var>'s \rreceive right named <var>name</var>.\rA port's make-send count specifies the number of send rights that have\rbeen generated via the port's receive right.  A port's make-send count\ris set to zero when the port is first allocated; the count is reset to\rzero each time the port's receive right is transferred via a Mach message. \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_get_attributes.html"><strong>mach_port_get_attributes</strong></a>.\r
\ No newline at end of file
+<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>.