xnu-792.21.3.tar.gz

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

diff --git a/osfmk/man/io_done_queue_terminate.html b/osfmk/man/io_done_queue_terminate.html
index 67245742c13c65ba5b03bc657e06bb597670ff83..7d5f76a28eaa61e27be4997b6dea3e6274d181b7 100755 (executable)
--- a/osfmk/man/io_done_queue_terminate.html
+++ b/osfmk/man/io_done_queue_terminate.html
@@ -1 +1,41 @@
-<h2>io_done_queue_terminate</h2>\r<hr>\r<p>\r<strong>Function</strong> - Terminate an io_done_queue kernel object.\r<h3>SYNOPSIS</h3>\r<pre>\r<strong>#include&ltdevice/device.h&gt</strong>\r\r<strong>kern_return_t  io_done_queue_terminate</strong>\r               <strong>(mach_port_t</strong>   <var>queue</var><strong>);</strong>\r</pre>\r<h3>PARAMETERS</h3>\r<dl>\r<p>\r<dt> <var>queue</var>\r<dd>\r[in io-done-queue send right] The port referencing the <strong>io_done_queue</strong> \rto be destroyed.\r</dl>\r<h3>DESCRIPTION</h3>\r<p>\rThe <strong>io_done_queue_terminate</strong> function is called to destroy a previous\rinstatiation of the kernel object supporting asynchronous read/write\roperations on a device.\r<h3>RETURN VALUES</h3>\r<dl>\r  <dt> <strong>KERN_INVALID_ARGUMENT</strong>\r<dd>\r     Invalid <var>queue</var> parameter.\r     <p>\r</dl>\r<h3>RELATED INFORMATION</h3>\r<p>\rFunctions:\r<a href="io_done_queue_create.html"><strong>io_done_queue_create</strong></a>,\r<a href="io_done_queue_wait.html"><strong>io_done_queue_wait</strong></a>,\r<a href="device_read_async.html"><strong>device_read_async</strong></a>,\r<a href="device_read_async_inband.html"><strong>device_read_async_inband</strong></a>,\r<a href="DR_overwrite_async.html"><strong>device_read_overwrite_async</strong></a>,\r<a href="device_write_async.html"><strong>device_write_async</strong></a>,\r<a href="device_write_async_inband.html"><strong>device_write_async_inband</strong></a>.\r
\ No newline at end of file
+<h2>io_done_queue_terminate</h2>
+<hr>
+<p>
+<strong>Function</strong> - Terminate an io_done_queue kernel object.
+<h3>SYNOPSIS</h3>
+<pre>
+<strong>#include&ltdevice/device.h&gt</strong>
+
+<strong>kern_return_t  io_done_queue_terminate</strong>
+               <strong>(mach_port_t</strong>   <var>queue</var><strong>);</strong>
+</pre>
+<h3>PARAMETERS</h3>
+<dl>
+<p>
+<dt> <var>queue</var>
+<dd>
+[in io-done-queue send right] The port referencing the <strong>io_done_queue</strong> 
+to be destroyed.
+</dl>
+<h3>DESCRIPTION</h3>
+<p>
+The <strong>io_done_queue_terminate</strong> function is called to destroy a previous
+instatiation of the kernel object supporting asynchronous read/write
+operations on a device.
+<h3>RETURN VALUES</h3>
+<dl>
+  <dt> <strong>KERN_INVALID_ARGUMENT</strong>
+<dd>
+     Invalid <var>queue</var> parameter.
+     <p>
+</dl>
+<h3>RELATED INFORMATION</h3>
+<p>
+Functions:
+<a href="io_done_queue_create.html"><strong>io_done_queue_create</strong></a>,
+<a href="io_done_queue_wait.html"><strong>io_done_queue_wait</strong></a>,
+<a href="device_read_async.html"><strong>device_read_async</strong></a>,
+<a href="device_read_async_inband.html"><strong>device_read_async_inband</strong></a>,
+<a href="DR_overwrite_async.html"><strong>device_read_overwrite_async</strong></a>,
+<a href="device_write_async.html"><strong>device_write_async</strong></a>,
+<a href="device_write_async_inband.html"><strong>device_write_async_inband</strong></a>.