Added a little more description of return value from

comedi_mark_buffer_read(), from Jan Gukelberger <g.u.g.i@gmx.de>.
This commit is contained in:
Frank Mori Hess 2007-12-17 00:06:39 +00:00
parent 0b21f80783
commit 624228b8fe

View file

@ -1023,7 +1023,10 @@ Description:
transferred via read() calls. This function is
used to indicate that the next num_bytes bytes in the buffer
are no longer needed and may be discarded.
If there is an error, -1 is returned.
Returns:
A return value ret greater than 0 indicates that the read offset in
the streaming buffer, as returned by comedi_get_buffer_offset, has been
incremented by ret bytes. If there is an error, -1 is returned.
Function: comedi_mark_buffer_written -- streaming buffer control
Retval: int