videolan
/
vlc
mirror of https://code.videolan.org/videolan/vlc
1
Fork 0
Code Releases Activity

vlc_stream: fix the vlc_stream_ReadPartial() documentation 

vlc_stream_ReadPartial() is similar to pf_read of stream_t. It is often used
as such in pf_read callbacks.

vlc_stream_Read() uses it that way as well. On negative return values (-1)
it continues reading.

Internally it's calling vlc_stream_ReadRaw() which also returns pf_read return
values verbatim.
This commit is contained in:
Steve Lhomme 2022-06-22 08:43:12 +02:00 committed by Felix Paul Kühne
parent 1cd6abdf6c
commit c3c2d535cc
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
include/vlc_stream.h
View File

@ -200,7 +200,7 @@ VLC_API ssize_t vlc_stream_Read(stream_t *, void *buf, size_t len) VLC_USED;
*
* \param buf start of buffer to read data into [OUT]
* \param len buffer size (maximum number of bytes to read)
* \return the number of bytes read or a negative value on error.
* \return the number of bytes read, 0 on end of stream or -1 if no data available
*/
VLC_API ssize_t vlc_stream_ReadPartial(stream_t *, void *buf, size_t len)
VLC_USED;