Function
GLibfile_get_contents
Declaration
gboolean
g_file_get_contents (
const gchar* filename,
gchar** contents,
gsize* length,
GError** error
)
Description
Reads an entire file into allocated memory, with good error checking.
If the call was successful, it returns TRUE
and sets contents
to the file
contents and length
to the length of the file contents in bytes. The string
stored in contents
will be nul-terminated, so for text files you can pass
NULL
for the length
argument. If the call was not successful, it returns
FALSE
and sets error
. The error domain is G_FILE_ERROR
. Possible error
codes are those in the GFileError
enumeration. In the error case,
contents
is set to NULL
and length
is set to zero.
Parameters
filename |
const gchar* |
Name of a file to read contents from, in the GLib file name encoding. |
|
The data is owned by the caller of the function. | |
The value is a file system path, using the OS encoding. | |
contents |
An array of guint8 |
Location to store an allocated string, use |
|
The argument will be set by the function. | |
The length of the array is specified in the length argument. | |
The called function takes ownership of the data, and is responsible for freeing it. | |
length |
gsize* |
Location to store length in bytes of the contents, or |
|
The argument will be set by the function. | |
The argument can be set to NULL . | |
error |
GError ** |
The return location for a GError* , or NULL . |