luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-12-26 15:36:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

doc: improve doc of g_input_stream_read()

Browse Source 
I recently needed to nul-terminate the returned buffer, and I wasn't
sure if g_input_stream_read() does that or not. I've checked
glocalfileinputstream.c, which calls read(2) which doesn't nul-terminate
the buffer. So I assume it's the same behavior for all GInputStream
subclasses.

https://bugzilla.gnome.org/show_bug.cgi?id=732704
This commit is contained in:
Sébastien Wilmet 2014-07-03 18:02:31 +02:00
parent b0c7221c55
commit 48c7d041e2
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
gio/ginputstream.c
View File

@ -141,6 +141,9 @@ g_input_stream_init (GInputStream *stream)
* can happen e.g. near the end of a file. Zero is returned on end of file * can happen e.g. near the end of a file. Zero is returned on end of file
* (or if @count is zero), but never otherwise. * (or if @count is zero), but never otherwise.
* *
* The returned @buffer is not a nul-terminated string, it can contain nul bytes
* at any position, and this function doesn't nul-terminate the @buffer.
*
* If @cancellable is not %NULL, then the operation can be cancelled by * If @cancellable is not %NULL, then the operation can be cancelled by
* triggering the cancellable object from another thread. If the operation * triggering the cancellable object from another thread. If the operation
* was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If an * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If an