COMEDI_GET_BUFFER_RE(3)

📦
version 0.11.0+5 · 7 versions
, in ubuntu resolute, ubuntu stonking

💖 COMEDI_GET_BUFFER_RE(3) 💖

okay bestie, so this is a page from the Comedi reference manual (that's the manual name, it's literally called Comedi), and we're about to get into comedi_get_buffer_read_count. it's giving short-king manpage but the lore is real. 🦋

✨ NAME ✨

comedi_get_buffer_read_count — bestie, it counts the reads in your streaming buffer 📖🔥

🌸 SYNOPSIS 🌸

lowkey just include the header and call the thing, no cap:

#include <comedilib.h>

int comedi_get_buffer_read_count(comedi_t * device,
                                 unsigned int subdevice,
                                 unsigned int * read_count);

🎀 DESCRIPTION 🎀

so here's the vibe. comedi_get_buffer_read_count is the function you call on a subdevice that already has a Comedi command in progress — like, the stream is streaming, the data is data-ing 🫶 — and what it gives you back is the number of bytes that have been read from the buffer, taken modulo UINT_MAX + 1.

like, yes, it wraps. it's math. it's modulo UINT_MAX + 1 energy and we respect it. 💅

and where does that gorgeous number go? it gets stored in *read_count. that's the pointer you handed over, bestie, that's where the tea lives ☕✨

⭐ RETURN VALUE ⭐

  • on success, you get 0 back. slay. 👑
  • on failure, you get -1 back. not slay. 😭

💜 AUTHORS 💜

the icons who made this happen, fr fr:

  • David Schleef <ds@schleef.org> — Author. 🧚
  • Frank Mori Hess <fmhess@users.sourceforge.net> — Author. ✨
  • Herman Bruyninckx <Herman.Bruyninckx@mech.kuleuven.ac.be> — Author. 🌸
  • Bernd Porr <tech@linux-usb-daq.co.uk> — Author. 🦋
  • Ian Abbott <abbotti@mev.co.uk> — Author. 💖
  • Éric Piel <piel@delmic.com> — Author. 🌈

legal bit, but make it cute. here we go:

  • Copyright © 1998-2003 David Schleef
  • Copyright © 2001-2003, 2005, 2008 Frank Mori Hess
  • Copyright © 2002-2003 Herman Bruyninckx
  • Copyright © 2012 Bernd Porr
  • Copyright © 2012 Ian Abbott
  • Copyright © 2012, 2015 Éric Piel

this document is part of Comedilib. and in the context of this document specifically, the term "source code" as defined by the license is interpreted as the XML source. yes really, that's the rule. 🙈

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, version 2.1 of the License.
This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. 👑 (yes, that's the whole screaming-caps situation, it's not me being dramatic, that's what it says)
You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.

and that's the whole page bestie, no crumbs left 💅 this lil drop came from the Comedi crew and it's dated 03/20/2026 — catch you on the next man page, mwah 🎀💖✨

📦 where this page comes from