Method

IbisClientparse_mode_string

unstable since: 0.12

Declaration [src]

IbisModeChange*
ibis_client_parse_mode_string (
  IbisClient* client,
  const char* mode_string,
  GStrv params,
  guint* n_changes,
  GError** error
)

Description [src]

Parses the given mode string.

The parameters of the IbisModeChange are only valid as long as params is valid.

An array is always returned even on error.

Available since: 0.12

Parameters

mode_string

Type: const char*

The mode string.

The data is owned by the caller of the method.

The value is a NUL terminated UTF-8 string.

params

Type: An array of utf8

The parameters.

The argument can be NULL.

The array must be NULL-terminated.

Each element is a NUL terminated UTF-8 string.

n_changes

Type: guint*

A return address for the number of changes.

The argument will be set by the function.

The argument can be NULL.

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: An array of IbisModeChange

An array of mode changes.

The array is NULL-terminated.

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