xnu-4903.221.2.tar.gz

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

diff --git a/osfmk/man/mach_port_deallocate.html b/osfmk/man/mach_port_deallocate.html
old mode 100755 (executable)
new mode 100644 (file)
index 524e25a..a03e4d8
--- a/osfmk/man/mach_port_deallocate.html
+++ b/osfmk/man/mach_port_deallocate.html
@@ -1 +1,57 @@
-<h2>mach_port_deallocate</h2>\r<hr>\r<p>\r<strong>Function</strong> - Decrement the target port right's user reference count.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>kern_return_t   mach_port_deallocate</strong>\r                <strong>(ipc_space_t</strong>                               <var>task</var>,\r                 <strong>mach_port_name_t</strong>                          <var>name</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 the right.\r<p>\r<dt> <var>name</var> \r<dd>\r[in scalar]\rThe task's name for the right.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>mach_port_deallocate</strong> function releases a user reference\rfor a right.  It is \ran alternate form of <strong>mach_port_mod_refs</strong> that allows\ra task to release a user \rreference for a send or send-once right without failing if the\rport has died and \rthe right is now actually a dead name.\r<p>\rIf <var>name</var> denotes a dead name, send right, or send-once right,\rthen the right loses \rone user reference.  If it only had one user reference, then\rthe right is destroyed. \rIf <var>name</var> does not denote an element in the port name space, the\rfunction returns \rsuccess.\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_RIGHT</strong>\r<dd>\rThe <var>name</var> parameter denoted an invalid 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_mod_refs.html"><strong>mach_port_mod_refs</strong></a>.\r
\ No newline at end of file
+<h2>mach_port_deallocate</h2>
+<hr>
+<p>
+<strong>Function</strong> - Decrement the target port right's user reference count.
+<h3>SYNOPSIS</h3>
+<pre>
+<strong>kern_return_t   mach_port_deallocate</strong>
+                <strong>(ipc_space_t</strong>                               <var>task</var>,
+                 <strong>mach_port_name_t</strong>                          <var>name</var><strong>);</strong>
+</pre>
+<h3>PARAMETERS</h3>
+<dl>
+<p>
+<dt> <var>task</var> 
+<dd>
+[in task send right]
+The task holding the right.
+<p>
+<dt> <var>name</var> 
+<dd>
+[in scalar]
+The task's name for the right.
+</dl>
+<h3>DESCRIPTION</h3>
+<p>
+The <strong>mach_port_deallocate</strong> function releases a user reference
+for a right.  It is 
+an alternate form of <strong>mach_port_mod_refs</strong> that allows
+a task to release a user 
+reference for a send or send-once right without failing if the
+port has died and 
+the right is now actually a dead name.
+<p>
+If <var>name</var> denotes a dead name, send right, or send-once right,
+then the right loses 
+one user reference.  If it only had one user reference, then
+the right is destroyed. 
+If <var>name</var> does not denote an element in the port name space, the
+function returns 
+success.
+<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_RIGHT</strong>
+<dd>
+The <var>name</var> parameter denoted an invalid 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_mod_refs.html"><strong>mach_port_mod_refs</strong></a>.