stv0g/comedilib
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

doc/funcref: Added missing comedi_data_read_n

Browse source 
There was a broken link to the comedi_data_read_n function from
elsewhere, so we'd better add a section for it.
This commit is contained in:
Ian Abbott 2012-05-01 17:42:15 +01:00
parent 7655653daf
commit 5392632a1c
1 changed files with 16 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
doc/funcref
View file

@ -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