Function

GLibOptionErrorFunc

Declaration

void
(* GOptionErrorFunc) (
  GOptionContext* context,
  GOptionGroup* group,
  gpointer user_data,
  GError** error
)

Description

The type of function to be used as callback when a parse error occurs.

Parameters

context

Type: GOptionContext

The active GOptionContext.

The data is owned by the caller of the function.

group

Type: GOptionGroup

The group to which the function belongs.

The data is owned by the caller of the function.

user_data

Type: gpointer

User data added to the GOptionGroup containing the option when it was created with g_option_group_new()

The argument can be NULL.

The data is owned by the caller of the function.

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 function 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.