Method

GioFileload_contents

Declaration

gboolean
g_file_load_contents (
  GFile* file,
  GCancellable* cancellable,
  char** contents,
  gsize* length,
  char** etag_out,
  GError** error
)

Description

Loads the content of the file into memory. The data is always zero-terminated, but this is not included in the resultant length. The returned contents should be freed with g_free() when no longer needed.

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.

Parameters

`cancellable`	`GCancellable`
	Optional `GCancellable` object, `NULL` to ignore.
	The argument can be `NULL`.
	The data is owned by the caller of the function.
`contents`	An array of `guint8`
	A location to place the contents of the file.
	The argument will be set by the function.
	The length of the array is specified in the `length` argument.
	The instance takes ownership of the data, and is responsible for freeing it.
`length`	`gsize*`
	A location to place the length of the contents of the file, or `NULL` if the length is not needed.
	The argument will be set by the function.
	The argument can be `NULL`.
`etag_out`	`char**`
	A location to place the current entity tag for the file, or `NULL` if the entity tag is not needed.
	The argument will be set by the function.
	The argument can be set to `NULL`.
	The argument can be `NULL`.
	The instance takes ownership of the data, and is responsible for freeing it.
	The value is a NUL terminated UTF-8 string.
`error`	`GError **`
	The return location for a `GError*`, or `NULL`.

Return value

Returns:	`gboolean`
	`TRUE` if the `file`‘s contents were successfully loaded. `FALSE` if there were errors.