[vlc-commits] [Git][videolan/vlc][master] vlc_stream: fix the vlc_stream_ReadPartial() documentation

Felix Paul Kühne (@fkuehne) gitlab at videolan.org
Fri Jun 24 09:14:16 UTC 2022



Felix Paul Kühne pushed to branch master at VideoLAN / VLC


Commits:
c3c2d535 by Steve Lhomme at 2022-06-24T08:58:46+00:00
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.

- - - - -


1 changed file:

- include/vlc_stream.h


Changes:

=====================================
include/vlc_stream.h
=====================================
@@ -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;



View it on GitLab: https://code.videolan.org/videolan/vlc/-/commit/c3c2d535cc05c8d8b32519a7b7f4e4a02b502663

-- 
View it on GitLab: https://code.videolan.org/videolan/vlc/-/commit/c3c2d535cc05c8d8b32519a7b7f4e4a02b502663
You're receiving this email because of your account on code.videolan.org.


VideoLAN code repository instance


More information about the vlc-commits mailing list