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

NAME

6       comedi_get_buffer_contents - streaming buffer status
7

SYNOPSIS

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

DESCRIPTION

15       The function comedi_get_buffer_contents is used on a subdevice that has
16       a Comedi command in progress to get the number of unread bytes. For a
17       streaming input command, this is the number of bytes that can be read.
18       For a streaming output command, subtracting this from the buffer size
19       gives the space available to be written.
20

RETURN VALUE

22       On success, comedi_get_buffer_contents returns the number of unread
23       bytes in the buffer. On failure, -1 is returned.
24

AUTHORS

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