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

g_output_stream_write: fix misleadingly ungrammatical documentation

Browse Source 
pointed out in https://bugzilla.gnome.org/show_bug.cgi?id=626866
This commit is contained in:
Dan Winship 2010-09-17 10:21:57 -04:00
parent 8a7365d892
commit bff4ac15d0
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
gio/goutputstream.c
View File

@ -156,18 +156,19 @@ g_output_stream_init (GOutputStream *stream)
* Tries to write @count bytes from @buffer into the stream. Will block
* during the operation.
*
* If count is zero returns zero and does nothing. A value of @count
* If count is 0, returns 0 and does nothing. A value of @count
* larger than %G_MAXSSIZE will cause a %G_IO_ERROR_INVALID_ARGUMENT error.
*
* On success, the number of bytes written to the stream is returned.
* It is not an error if this is not the same as the requested size, as it
* can happen e.g. on a partial i/o error, or if there is not enough
* storage in the stream. All writes either block until at least one byte
* is written, so zero is never returned (unless @count is zero).
* can happen e.g. on a partial I/O error, or if there is not enough
* storage in the stream. All writes block until at least one byte
* is written or an error occurs; 0 is never returned (unless
* @count is 0).
*
* 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
* was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If an
* operation was partially finished when the operation was cancelled the
* partial result will be returned, without an error.
*