debian man page for comedi_get_hardware_buffer_size

COMEDI_GET_HARDWARE_(3) 					 Comedi reference					   COMEDI_GET_HARDWARE_(3)

NAME
       comedi_get_hardware_buffer_size - get size of subdevice's hardware buffer

SYNOPSIS
       #include <comedilib.h>

       int comedi_get_hardware_buffer_size(comedi_t *device, unsigned int subdevice, enum comedi_io_direction direction);

DESCRIPTION
       This function returns the number of bytes the subdevice can hold in it's hardware buffer. The term "hardware buffer" refers to any FIFOs,
       etc. on the acquisition board itself which are used during streaming commands. This does not include the buffer maintained by the comedi
       kernel module in host memory, whose size may be queried by comedi_get_buffer_size. The direction parameter of type enum comedi_io_direction
       should be set to COMEDI_INPUT to query the input buffer size (e.g., the buffer of an analog input subdevice), or COMEDI_OUTPUT to query the
       output buffer size (e.g., the buffer of an analog output).

RETURN VALUE
       Hardware buffer size in bytes, or -1 on error.

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

COPYRIGHT
       Copyright (C) 1998-2003 David Schleef
       Copyright (C) 2001-2003, 2005, 2008 Frank Mori Hess
       Copyright (C) 2002-2003 Herman Bruyninckx
       Copyright (C) 2012 Bernd Porr
       Copyright (C) 2012 Ian Abbott

       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.

Comedi								    07/06/2012						   COMEDI_GET_HARDWARE_(3)