1COMEDI_GET_BUFFER_RE(3)        Comedi reference        COMEDI_GET_BUFFER_RE(3)
2
3
4

NAME

6       comedi_get_buffer_read_offset - streaming buffer read offset
7

SYNOPSIS

9       #include <comedilib.h>
10
11       int comedi_get_buffer_read_offset(comedi_t * device,
12                                         unsigned int subdevice);
13

DESCRIPTION

15       The function comedi_get_buffer_read_offset is used on a subdevice that
16       has a Comedi command in progress to get the current read position in
17       the streaming buffer as an offset in bytes from the start of the
18       buffer. The position will wrap around to 0 when it reaches the buffer
19       size. This offset is only useful for memory mapped buffers.
20
21       This function replaces comedi_get_buffer_offset and has the same
22       functionality.
23

RETURN VALUE

25       On success, comedi_get_buffer_read_offset returns the current read
26       position as an offset in bytes from the start of the buffer. On
27       failure, -1 is returned.
28

AUTHORS

30       David Schleef <ds@schleef.org>
31           Author.
32
33       Frank Mori Hess <fmhess@users.sourceforge.net>
34           Author.
35
36       Herman Bruyninckx <Herman.Bruyninckx@mech.kuleuven.ac.be>
37           Author.
38
39       Bernd Porr <tech@linux-usb-daq.co.uk>
40           Author.
41
42       Ian Abbott <abbotti@mev.co.uk>
43           Author.
44
45       Éric Piel <piel@delmic.com>
46           Author.
47
49       Copyright © 1998-2003 David Schleef
50       Copyright © 2001-2003, 2005, 2008 Frank Mori Hess
51       Copyright © 2002-2003 Herman Bruyninckx
52       Copyright © 2012 Bernd Porr
53       Copyright © 2012 Ian Abbott
54       Copyright © 2012, 2015 Éric Piel
55
56       This document is part of Comedilib. In the context of this document,
57       the term "source code" as defined by the license is interpreted as the
58       XML source.
59
60       This library is free software; you can redistribute it and/or modify it
61       under the terms of the GNU Lesser General Public License as published
62       by the Free Software Foundation, version 2.1 of the License.
63
64       This library is distributed in the hope that it will be useful, but
65       WITHOUT ANY WARRANTY; without even the implied warranty of
66       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
67       General Public License for more details.
68
69       You should have received a copy of the GNU Lesser General Public
70       License along with this library; if not, write to the Free Software
71       Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
72       USA.
73
74
75
76
77Comedi                            05/11/2017           COMEDI_GET_BUFFER_RE(3)
Impressum