COMEDI_GET_BUFFER_CO(3)

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

🦋 comedi_get_buffer_contents — streaming buffer status 💅

ok so bestie, we're in section 3 of the Comedi reference, and today's main character is comedi_get_buffer_contents — the little function that tells you how much stuff is sitting in your streaming buffer. let's get into it ✨

✨ NAME ✨

comedi_get_buffer_contents — streaming buffer status 🎀

🌸 SYNOPSIS 🌸

#include <comedilib.h>

int comedi_get_buffer_contents(comedi_t * device,
                               unsigned int subdevice);

💖 DESCRIPTION 💖

ok so here's the tea: comedi_get_buffer_contents is the function you call on a subdevice that already has a Comedi command in progress, and it hands you back the number of unread bytes. periodt.

it's giving two different vibes depending on which way your data is flowing:

  • for a streaming input command, this number is the number of bytes that can be read 👑
  • for a streaming output command, you gotta subtract this from the buffer size to get the space that's available to be written 🧚

so like, input? the number is literally your read buffet. output? do a lil math, subtraction girlies rise 🫶

⭐ RETURN VALUE ⭐

  • on success, comedi_get_buffer_contents returns the number of unread bytes in the buffer 💖
  • on failure, -1 is returned 😭

👑 AUTHORS 👑

these are the icons who made it happen, no cap:

  • 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.

the legal bit, and yes we're reading all of it because it matters fr fr:

  • 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. In the context of this document, the term "source code" as defined by the license is interpreted as the XML source.

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.

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.

bestie listen — that ALL CAPS WARRANTY part is not a joke. it's really no warranty, so read the license before you ship anything, okay? mwah 🫶

and that's the whole page, slay 💅 this was the Comedi reference, dated 03/20/2026 — comedi girlies stay winning, iykyk 🌟

📦 where this page comes from