gInputStreamRead

Share:

Description

Tries to read count bytes from the stream into the buffer starting at buffer. Will block during this read.

Usage

1
gInputStreamRead(object, count, cancellable = NULL, .errwarn = TRUE)

Arguments

object

a GInputStream.

count

the number of bytes that will be read from the stream

cancellable

optional GCancellable object, NULL to ignore.

.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 read into the buffer is returned. It is not an error if this is not the same as the requested size, as it 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.

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 read, or -1 on error

buffer

a buffer to read data into (which should be at least count bytes long).

error

location to store the error occuring, or NULL to ignore

Author(s)

Derived by RGtkGen from GTK+ documentation

Want to suggest features or report bugs for rdrr.io? Use the GitHub issue tracker.