1*d8b80295SApple OSS Distributions<h2>device_read_async_inband</h2> 2*d8b80295SApple OSS Distributions<hr> 3*d8b80295SApple OSS Distributions<p> 4*d8b80295SApple OSS Distributions<strong>System Trap</strong> - Read a sequence of bytes "inband" from a device object. 5*d8b80295SApple OSS Distributions<h3>SYNOPSIS</h3> 6*d8b80295SApple OSS Distributions<pre> 7*d8b80295SApple OSS Distributions<strong>kern_return_t device_read_async_inband</strong> 8*d8b80295SApple OSS Distributions <strong>(mach_port_t</strong> <var>device</var>, 9*d8b80295SApple OSS Distributions <strong>mach_port_t</strong> <var>queue</var>, 10*d8b80295SApple OSS Distributions <strong>mach_port_t</strong> <var>request_id</var>, 11*d8b80295SApple OSS Distributions <strong>dev_mode_t</strong> <var>mode</var>, 12*d8b80295SApple OSS Distributions <strong>recnum_t</strong> <var>recnum</var>, 13*d8b80295SApple OSS Distributions <strong>io_buf_len_t</strong> <var>bytes_wanted</var><strong>);</strong> 14*d8b80295SApple OSS Distributions</pre> 15*d8b80295SApple OSS Distributions<h3>PARAMETERS</h3> 16*d8b80295SApple OSS Distributions<dl> 17*d8b80295SApple OSS Distributions<p> 18*d8b80295SApple OSS Distributions<dt> <var>device</var> 19*d8b80295SApple OSS Distributions<dd> 20*d8b80295SApple OSS Distributions[in device send right] A device port to the device to be read. 21*d8b80295SApple OSS Distributions<p> 22*d8b80295SApple OSS Distributions<dt> <var>queue</var> 23*d8b80295SApple OSS Distributions<dd> 24*d8b80295SApple OSS Distributions[in io_done queue send right] The port returned from 25*d8b80295SApple OSS Distributions<strong>io_done_queue_create</strong>. 26*d8b80295SApple OSS Distributions<p> 27*d8b80295SApple OSS Distributions<dt> <var>request_id</var> 28*d8b80295SApple OSS Distributions<dd> 29*d8b80295SApple OSS Distributions[in send right] An unique request identifier that will be passed back as 30*d8b80295SApple OSS Distributionspart of the io_done_result structure. 31*d8b80295SApple OSS Distributions<p> 32*d8b80295SApple OSS Distributions<dt> <var>mode</var> 33*d8b80295SApple OSS Distributions<dd> 34*d8b80295SApple OSS Distributions[in scalar] I/O mode value. Meaningful options are: 35*d8b80295SApple OSS Distributions<p> 36*d8b80295SApple OSS Distributions <dl> 37*d8b80295SApple OSS Distributions<dt> <strong>D_NOWAIT</strong> 38*d8b80295SApple OSS Distributions<dd> 39*d8b80295SApple OSS DistributionsDo not wait if data is unavailable. 40*d8b80295SApple OSS Distributions </dl> 41*d8b80295SApple OSS Distributions<p> 42*d8b80295SApple OSS Distributions<dt> <var>recnum</var> 43*d8b80295SApple OSS Distributions<dd> 44*d8b80295SApple OSS Distributions[in scalar] Record number to be read. 45*d8b80295SApple OSS Distributions<p> 46*d8b80295SApple OSS Distributions<dt> <var>bytes_wanted</var> 47*d8b80295SApple OSS Distributions<dd> 48*d8b80295SApple OSS Distributions[in scalar] Size of data transfer. 49*d8b80295SApple OSS Distributions</dl> 50*d8b80295SApple OSS Distributions<h3>DESCRIPTION</h3> 51*d8b80295SApple OSS Distributions<p> 52*d8b80295SApple OSS DistributionsThe <strong>device_read_async_inband</strong> function enqueues a read operation for a 53*d8b80295SApple OSS Distributionssequence of bytes from a device object. The meaning of <var>recnum</var> as 54*d8b80295SApple OSS Distributionswell as the specific operation performed is device dependent. This 55*d8b80295SApple OSS Distributionscall differs from <strong>device_read_async</strong> in that the returned bytes are 56*d8b80295SApple OSS Distributionsreturned "inband" in the completion IPC message (in 57*d8b80295SApple OSS Distributions<strong>io_done_result.qd_inline</strong>). 58*d8b80295SApple OSS Distributions<h3>RETURN VALUES</h3> 59*d8b80295SApple OSS Distributions<p> 60*d8b80295SApple OSS Distributions<strong>device_read_async_inband</strong> returns only invalid parameter errors. 61*d8b80295SApple OSS Distributions<h3>RELATED INFORMATION</h3> 62*d8b80295SApple OSS Distributions<p> 63*d8b80295SApple OSS DistributionsFunctions: 64*d8b80295SApple OSS Distributions<a href="device_read_async.html"><strong>device_read_async</strong></a>, 65*d8b80295SApple OSS Distributions<a href="DR_overwrite_async.html"><strong>device_read_overwrite_async</strong></a>, 66*d8b80295SApple OSS Distributions<a href="device_write_async.html"><strong>device_write_async</strong></a>, 67*d8b80295SApple OSS Distributions<a href="device_write_async_inband.html"><strong>device_write_async_inband</strong></a>, 68*d8b80295SApple OSS Distributions<a href="io_done_queue_create.html"><strong>io_done_queue_create</strong></a>. 69