RGtk2 (version 2.20.31)

gFileRead: gFileRead

Description

Opens a file for reading. The result is a GFileInputStream that can be used to read the contents of the file.

Usage

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

Arguments

object

GFile to read.

cancellable

a GCancellable

.errwarn

Whether to issue a warning on error or fail silently

Value

A list containing the following elements:

retval

[GFileInputStream] GFileInputStream or NULL on error.

error

a GError, or NULL

Details

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 the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned. If the file is a directory, the G_IO_ERROR_IS_DIRECTORY error will be returned. Other errors are possible too, and depend on what kind of filesystem the file is on.