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-
Type:
GCancellableOptional
GCancellableobject,NULLto ignore.The argument can be NULL.The data is owned by the caller of the method. contents-
Type: An array of
guint8A 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 lengthargument.The caller of the method takes ownership of the data, and is responsible for freeing it. length-
Type:
gsize*A location to place the length of the contents of the file, or
NULLif the length is not needed.The argument will be set by the function. The argument can be NULL. etag_out-
Type:
char**A location to place the current entity tag for the file, or
NULLif the entity tag is not needed.The argument will be set by the function. The argument can be set to NULLby the method.The argument can be NULL.The caller of the method takes ownership of the data, and is responsible for freeing it. The value is a NUL terminated UTF-8 string. error-
Type:
GError **The return location for a recoverable error.
The argument can be NULL.If the return location is not NULL, then you must initialize it to aNULLGError*.The argument will be left initialized to NULLby the method if there are no errors.In case of error, the argument will be set to a newly allocated GError; the caller will take ownership of the data, and be responsible for freeing it.