Constructor

PurpleImagenew_from_file

since: 3.0

Declaration [src]

PurpleImage*
purple_image_new_from_file (
  const gchar* path,
  GError** error
)

Description [src]

Loads an image file as a new PurpleImage object. The path must exists, be readable and should point to a valid image file. If you don’t set be_eager parameter, there will be a risk that file will be removed from disk before you access its data.

Available since: 3.0

Parameters

path

Type: const gchar*

The path to the image file.

The data is owned by the caller of the function.
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 a NULL GError*.
The argument will left initialized to NULL by the constructor 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.

Return value

Type: PurpleImage

The new PurpleImage.

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