gOutputStreamWrite: gOutputStreamWrite

Description Usage Arguments Details Value Author(s)

View source: R/gioFuncs.R

Description

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

Usage

1
gOutputStreamWrite(object, buffer, cancellable = NULL, .errwarn = TRUE)

Arguments

object

a GOutputStream.

buffer

the buffer containing the data to write.

cancellable

optional cancellable object

.errwarn

Whether to issue a warning on error or fail silently

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.

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

Author(s)

Derived by RGtkGen from GTK+ documentation


RGtk2 documentation built on Oct. 14, 2021, 5:08 p.m.