gOutputStreamWrite: gOutputStreamWrite
Description
Tries to write count
bytes from buffer
into the stream. Will block
during the operation.Usage
gOutputStreamWrite(object, buffer, cancellable = NULL, .errwarn = TRUE)
Arguments
buffer
the buffer containing the data to write.
cancellable
optional cancellable object
.errwarn
Whether to issue a warning on error or fail silently
Value
A list containing the following elements:
- retval
- [integer] Number of bytes written, or -1 on error
error
- location to store the error occuring, or
NULL
to ignore
Details
If count is zero returns zero 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).
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
operation was partially finished when the operation was cancelled the
partial result will be returned, without an error.
On error -1 is returned and error
is set accordingly.