Method

GioOutputStreamwrite

Declaration

gssize
g_output_stream_write (
  GOutputStream* stream,
  void* buffer,
  gsize count,
  GCancellable* cancellable,
  GError** error
)

Description

Tries to write count bytes from buffer into the stream. Will block during the operation.

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 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 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.

Parameters

buffer An array of guint8
 

The buffer containing the data to write.

 The length of the array is specified in the count argument.
 The data is owned by the caller of the function.
count gsize
 

The number of bytes to write.

cancellable GCancellable
 

Optional cancellable object.

 The argument can be NULL.
 The data is owned by the caller of the function.
error GError **
  The return location for a GError*, or NULL.

Return value

Returns: gssize
 

Number of bytes written, or -1 on error.