From: Ian Abbott <abbotti@mev.co.uk>
Date: Tue, 1 May 2012 16:42:15 +0000 (+0100)
Subject: doc/funcref: Added missing comedi_data_read_n
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=5392632a1c93ca09f0fc3bcfd71936b258a6833c;p=comedilib.git

doc/funcref: Added missing comedi_data_read_n

There was a broken link to the comedi_data_read_n function from
elsewhere, so we'd better add a section for it.
---

diff --git a/doc/funcref b/doc/funcref
index 1df2f31..661a922 100644
--- a/doc/funcref
+++ b/doc/funcref
@@ -53,6 +53,22 @@ Returns:
  On success, comedi_data_read() returns 1 (the number of samples
  read).  If there is an error, -1 is returned.
 
+Function: comedi_data_read_n -- read multiple samples from channel
+Retval: int
+Param: comedi_t * device
+Param: unsigned int subdevice
+Param: unsigned int channel
+Param: unsigned int range
+Param: unsigned int aref
+Param: lsampl_t * data
+Param: unsigned int n
+Description:
+ Similar to
+ <link linkend="func-ref-comedi-data-read"><function>comedi_data_read</function></link>
+ except it reads <parameter>n</parameter> samples into the array
+ <parameter>data</parameter>. The precise timing of the samples is not
+ hardware controlled.
+
 Function: comedi_data_read_delayed -- read single sample from channel after delaying for specified settling time
 Retval: int
 Param: comedi_t * device