Initable

interface Initable

GInitable is implemented by objects that can fail during initialization. If an object implements this interface then it must be initialized as the first thing after construction, either via method@Gio.Initable.init or method@Gio.AsyncInitable.init_async (the latter is only available if it also implements iface@Gio.AsyncInitable).

If the object is not initialized, or initialization returns with an error, then all operations on the object except g_object_ref() and g_object_unref() are considered to be invalid, and have undefined behaviour. They will often fail with func@GLib.critical or func@GLib.warning, but this must not be relied on.

Users of objects implementing this are not intended to use the interface method directly, instead it will be used automatically in various ways. For C applications you generally just call func@Gio.Initable.new directly, or indirectly via a foo_thing_new() wrapper. This will call method@Gio.Initable.init under the cover, returning NULL and setting a GError on failure (at which point the instance is unreferenced).

For bindings in languages where the native constructor supports exceptions the binding could check for objects implementing GInitable during normal construction and automatically initialize them, throwing an exception on failure.

Skipped during bindings generation

  • function new: Varargs parameter is not supported

  • parameter var_args: va_list

  • parameter parameters: GObject.Parameter

Since

2.22

Inheritors

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
abstract val gioInitablePointer: <Error class: unknown class><<Error class: unknown class>>

Functions

Link copied to clipboard
open fun init(cancellable: Cancellable? = null): <Error class: unknown class><Boolean>

Initializes the object implementing the interface.