RGtk2 (version 2.20.31)

gBufferedInputStreamReadByte: gBufferedInputStreamReadByte

Description

Tries to read a single byte from the stream or the buffer. Will block during this read.

Usage

gBufferedInputStreamReadByte(object, cancellable = NULL, .errwarn = TRUE)

Arguments

object

GBufferedInputStream.

cancellable

optional GCancellable object, NULL to ignore.

.errwarn

Whether to issue a warning on error or fail silently

Value

A list containing the following elements:

retval

[integer] the byte read from the stream, or -1 on end of stream or error.

error

location to store the error occuring, or NULL to ignore.

Details

On success, the byte read from the stream is returned. On end of stream -1 is returned but it's not an exceptional error and error is not set. 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.