Method

GLibKeyFileload_from_file

Declaration

gboolean
g_key_file_load_from_file (
  GKeyFile* key_file,
  const gchar* file,
  GKeyFileFlags flags,
  GError** error
)

Description

Loads a key file into an empty GKeyFile structure.

If the OS returns an error when opening or reading the file, a G_FILE_ERROR is returned. If there is a problem parsing the file, a G_KEY_FILE_ERROR is returned.

This function will never return a G_KEY_FILE_ERROR_NOT_FOUND error. If the file is not found, G_FILE_ERROR_NOENT is returned.

Available since:

2.6

Parameters

`file`	`const gchar*`
	The path of a filename to load, in the GLib filename encoding.
	The data is owned by the caller of the function.
	The string is a file system path, using the OS encoding.
`flags`	`GKeyFileFlags`
	Flags from `GKeyFileFlags`.
`error`	`GError **`
	The return location for a `GError*`, or `NULL`.

Return value

Returns:	`gboolean`
	`TRUE` if a key file could be loaded, `FALSE` otherwise.