Method

GioFileread

Declaration

GFileInputStream*
g_file_read (
  GFile* file,
  GCancellable* cancellable,
  GError** error
)

Description

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

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.

Parameters

cancellable GCancellable
 

A GCancellable.

 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: GFileInputStream
 

GFileInputStream or NULL on error. Free the returned object with g_object_unref().

 The caller of the method takes ownership of the data, and is responsible for freeing it.