Commit 48c7d041 authored by Sébastien Wilmet's avatar Sébastien Wilmet

doc: improve doc of g_input_stream_read()

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
parent b0c7221c
......@@ -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
* (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
* triggering the cancellable object from another thread. If the operation
* was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If an
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment