Method

GtkUIManageradd_ui_from_string

deprecated: 3.10 since: 2.4

Declaration [src]

guint
gtk_ui_manager_add_ui_from_string (
  GtkUIManager* manager,
  const gchar* buffer,
  gssize length,
  GError** error
)

Description [src]

Parses a string containing a [UI definition][XML-UI] and merges it with the current contents of manager. An enclosing <ui> element is added if it is missing.

Available since: 2.4

Deprecated since: 3.10

Please do not use it in newly written code.

Parameters

buffer

Type: const gchar*

The string to parse.

The data is owned by the caller of the method.
The value is a NUL terminated UTF-8 string.
length

Type: gssize

The length of buffer (may be -1 if buffer is nul-terminated).

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 be left initialized to NULL by the method 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: guint

The merge id for the merged UI. The merge id can be used to unmerge the UI with gtk_ui_manager_remove_ui(). If an error occurred, the return value is 0.