MateConf Misc

## MateConf Misc MateConf Misc — The MateConf Library Utilities |

## Synopsis

    #include <runtime/na-mateconf-utils.h>

    GSList *            na_mateconf_utils_get_subdirs          (MateConfClient *mateconf,
                                                             const gchar *path);
    void                na_mateconf_utils_free_subdirs         (GSList *subdirs);
    gboolean            na_mateconf_utils_has_entry            (GSList *entries,
                                                             const gchar *entry);
    GSList *            na_mateconf_utils_get_entries          (MateConfClient *mateconf,
                                                             const gchar *path);
    gboolean            na_mateconf_utils_get_bool_from_entries
                                                            (GSList *entries,
                                                             const gchar *entry,
                                                             gboolean *value);
    gboolean            na_mateconf_utils_get_string_from_entries
                                                            (GSList *entries,
                                                             const gchar *entry,
                                                             gchar **value);
    gboolean            na_mateconf_utils_get_string_list_from_entries
                                                            (GSList *entries,
                                                             const gchar *entry,
                                                             GSList **value);
    void                na_mateconf_utils_dump_entries         (GSList *entries);
    void                na_mateconf_utils_free_entries         (GSList *entries);
    gboolean            na_mateconf_utils_read_bool            (MateConfClient *mateconf,
                                                             const gchar *path,
                                                             gboolean use_schema,
                                                             gboolean default_value);
    gint                na_mateconf_utils_read_int             (MateConfClient *mateconf,
                                                             const gchar *path,
                                                             gboolean use_schema,
                                                             gint default_value);
    gchar *             na_mateconf_utils_read_string          (MateConfClient *mateconf,
                                                             const gchar *path,
                                                             gboolean use_schema,
                                                             const gchar *default_value);
    GSList *            na_mateconf_utils_read_string_list     (MateConfClient *mateconf,
                                                             const gchar *path);
    gboolean            na_mateconf_utils_write_bool           (MateConfClient *mateconf,
                                                             const gchar *path,
                                                             gboolean value,
                                                             gchar **message);
    gboolean            na_mateconf_utils_write_int            (MateConfClient *mateconf,
                                                             const gchar *path,
                                                             gint value,
                                                             gchar **message);
    gboolean            na_mateconf_utils_write_string         (MateConfClient *mateconf,
                                                             const gchar *path,
                                                             const gchar *value,
                                                             gchar **message);
    gboolean            na_mateconf_utils_write_string_list    (MateConfClient *mateconf,
                                                             const gchar *path,
                                                             GSList *value,
                                                             gchar **message);
    gboolean            na_mateconf_utils_remove_entry         (MateConfClient *mateconf,
                                                             const gchar *path,
                                                             gchar **message);
    GSList *            na_mateconf_utils_slist_from_string    (const gchar *value);
    gchar *             na_mateconf_utils_slist_to_string      (GSList *slist);

## Description

Starting with Caja-Actions 3.1.0, MateConf, whether it is used as a preference storage subsystem or as an I/O provider, is deprecated.

## Details

### na_mateconf_utils_get_subdirs ()

    GSList *            na_mateconf_utils_get_subdirs          (MateConfClient *mateconf,
                                                             const gchar *path);

`mateconf` : | a MateConfClient instance.
`path` : | a full path to be read.
Returns : | a list of full path subdirectories. The returned list should be `na_mateconf_utils_free_subdirs()` by the caller.

Since 2.30

### na_mateconf_utils_free_subdirs ()

    void                na_mateconf_utils_free_subdirs         (GSList *subdirs);

Release the list.

`subdirs` : | the subdirectory list as returned from `na_mateconf_utils_get_subdirs()`.

Since 2.30

### na_mateconf_utils_has_entry ()

    gboolean            na_mateconf_utils_has_entry            (GSList *entries,
                                                             const gchar *entry);

`entries` : | the list of entries as returned by `na_mateconf_utils_get_entries()`.
`entry` : | the entry to be tested.
Returns : | `TRUE` if the given `entry` exists in the specified `entries`, `FALSE` else.

Since 2.30

### na_mateconf_utils_get_entries ()

    GSList *            na_mateconf_utils_get_entries          (MateConfClient *mateconf,
                                                             const gchar *path);

Loads all the key=value pairs of the specified key.

`mateconf` : | a MateConfClient instance.
`path` : | a full path to be read.
Returns : | a list of MateConfEntry. The returned list is not recursive : it contains only the immediate children of `path`. To free the returned list, call `na_mateconf_utils_free_entries()`.

Since 2.30

### na_mateconf_utils_get_bool_from_entries ()

    gboolean            na_mateconf_utils_get_bool_from_entries
                                                            (GSList *entries,
                                                             const gchar *entry,
                                                             gboolean *value);

`entries` : | a list of MateConfEntry as returned by `na_mateconf_utils_get_entries()`.
`entry` : | the searched entry.
`value` : | a pointer to a gboolean to be set to the found value.
Returns : | `TRUE` if the entry was found, `FALSE` else. If the entry was not found, or was not of boolean type, `value` is set to `FALSE`.

Since 2.30

### na_mateconf_utils_get_string_from_entries ()

    gboolean            na_mateconf_utils_get_string_from_entries
                                                            (GSList *entries,
                                                             const gchar *entry,
                                                             gchar **value);

`entries` : | a list of MateConfEntry as returned by `na_mateconf_utils_get_entries()`.
`entry` : | the searched entry.
`value` : | a pointer to a gchar * to be set to the found value.
Returns : | `TRUE` if the entry was found, `FALSE` else. If the entry was not found, or was not of string type, `value` is set to `NULL`. If `value` is returned not NULL, it should be `g_free()` by the caller.

Since 2.30

### na_mateconf_utils_get_string_list_from_entries ()

    gboolean            na_mateconf_utils_get_string_list_from_entries
                                                            (GSList *entries,
                                                             const gchar *entry,
                                                             GSList **value);

`entries` : | a list of MateConfEntry as returned by `na_mateconf_utils_get_entries()`.
`entry` : | the searched entry.
`value` : | a pointer to a GSList * to be set to the found value.
Returns : | `TRUE` if the entry was found, `FALSE` else. If the entry was not found, or was not of string list type, `value` is set to `NULL`. If `value` is returned not NULL, it should be `na_core_utils_slist_free()` by the caller.

Since 2.30

### na_mateconf_utils_dump_entries ()

    void                na_mateconf_utils_dump_entries         (GSList *entries);

Dumps the content of the entries.

`entries` : | a list of MateConfEntry as returned by `na_mateconf_utils_get_entries()`.

Since 2.30

### na_mateconf_utils_free_entries ()

    void                na_mateconf_utils_free_entries         (GSList *entries);

Releases the provided list.

`entries` : | a list of MateConfEntry as returned by `na_mateconf_utils_get_entries()`.

Since 2.30

### na_mateconf_utils_read_bool ()

    gboolean            na_mateconf_utils_read_bool            (MateConfClient *mateconf,
                                                             const gchar *path,
                                                             gboolean use_schema,
                                                             gboolean default_value);

`mateconf` : | a MateConfClient instance.
`path` : | the full path to the key.
`use_schema` : | whether to use the default value from schema, or not.
`default_value` : | default value to be used if schema is not used or doesn't exist.
Returns : | the required boolean value.

Since 2.30

### na_mateconf_utils_read_int ()

    gint                na_mateconf_utils_read_int             (MateConfClient *mateconf,
                                                             const gchar *path,
                                                             gboolean use_schema,
                                                             gint default_value);

`mateconf` : | a MateConfClient instance.
`path` : | the full path to the key.
`use_schema` : | whether to use the default value from schema, or not.
`default_value` : | default value to be used if schema is not used or doesn't exist.
Returns : | the required integer value.

Since 2.30

### na_mateconf_utils_read_string ()

    gchar *             na_mateconf_utils_read_string          (MateConfClient *mateconf,
                                                             const gchar *path,
                                                             gboolean use_schema,
                                                             const gchar *default_value);

`mateconf` : | a MateConfClient instance.
`path` : | the full path to the key.
`use_schema` : | whether to use the default value from schema, or not.
`default_value` : | default value to be used if schema is not used or doesn't exist.
Returns : | the required string value in a newly allocated string which should be `g_free()` by the caller.

Since 2.30

### na_mateconf_utils_read_string_list ()

    GSList *            na_mateconf_utils_read_string_list     (MateConfClient *mateconf,
                                                             const gchar *path);

`mateconf` : | a MateConfClient instance.
`path` : | the full path to the key to be read.
Returns : | a list of strings, or `NULL` if the entry was not found or was not of string list type. The returned list must be released with `na_core_utils_slist_free()`.

Since 2.30

### na_mateconf_utils_write_bool ()

    gboolean            na_mateconf_utils_write_bool           (MateConfClient *mateconf,
                                                             const gchar *path,
                                                             gboolean value,
                                                             gchar **message);

### Warning

`na_mateconf_utils_write_bool` is deprecated and should not be used in newly-written code. 3.1

Writes a boolean at the given `path`.

`mateconf` : | a MateConfClient instance.
`path` : | the full path to the key.
`value` : | the value to be written.
`message` : | a pointer to a gchar * which will be allocated if needed.
Returns : | `TRUE` if the writing has been successful, `FALSE` else. If returned not NULL, the `message` contains an error message. It should be `g_free()` by the caller.

Since 2.30

### na_mateconf_utils_write_int ()

    gboolean            na_mateconf_utils_write_int            (MateConfClient *mateconf,
                                                             const gchar *path,
                                                             gint value,
                                                             gchar **message);

### Warning

`na_mateconf_utils_write_int` is deprecated and should not be used in newly-written code. 3.1

Writes an integer at the given `path`.

`mateconf` : | a MateConfClient instance.
`path` : | the full path to the key.
`value` : | the value to be written.
`message` : | a pointer to a gchar * which will be allocated if needed.
Returns : | `TRUE` if the writing has been successful, `FALSE` else. If returned not NULL, the `message` contains an error message. It should be `g_free()` by the caller.

Since 2.30

### na_mateconf_utils_write_string ()

    gboolean            na_mateconf_utils_write_string         (MateConfClient *mateconf,
                                                             const gchar *path,
                                                             const gchar *value,
                                                             gchar **message);

### Warning

`na_mateconf_utils_write_string` is deprecated and should not be used in newly-written code. 3.1

Writes a string at the given `path`.

`mateconf` : | a MateConfClient instance.
`path` : | the full path to the key.
`value` : | the value to be written.
`message` : | a pointer to a gchar * which will be allocated if needed.
Returns : | `TRUE` if the writing has been successful, `FALSE` else. If returned not NULL, the `message` contains an error message. It should be `g_free()` by the caller.

Since 2.30

### na_mateconf_utils_write_string_list ()

    gboolean            na_mateconf_utils_write_string_list    (MateConfClient *mateconf,
                                                             const gchar *path,
                                                             GSList *value,
                                                             gchar **message);

### Warning

`na_mateconf_utils_write_string_list` is deprecated and should not be used in newly-written code. 3.1

Writes a list of strings at the given `path`.

`mateconf` : | a MateConfClient instance.
`path` : | the full path to the key.
`value` : | the list of values to be written.
`message` : | a pointer to a gchar * which will be allocated if needed.
Returns : | `TRUE` if the writing has been successful, `FALSE` else. If returned not NULL, the `message` contains an error message. It should be `g_free()` by the caller.

Since 2.30

### na_mateconf_utils_remove_entry ()

    gboolean            na_mateconf_utils_remove_entry         (MateConfClient *mateconf,
                                                             const gchar *path,
                                                             gchar **message);

### Warning

`na_mateconf_utils_remove_entry` is deprecated and should not be used in newly-written code. 3.1

Removes an entry from user preferences.

`mateconf` : | a MateConfClient instance.
`path` : | the full path to the entry.
`message` : | a pointer to a gchar * which will be allocated if needed.
Returns : | `TRUE` if the operation was successful, `FALSE` else.

Since 2.30

### na_mateconf_utils_slist_from_string ()

    GSList *            na_mateconf_utils_slist_from_string    (const gchar *value);

### Warning

`na_mateconf_utils_slist_from_string` is deprecated and should not be used in newly-written code. 3.1

Converts a string representing a list of strings in a MateConf format to a list of strings.

`value` : | a string of the form [xxx,yyy,...] as read from MateConf.
Returns : | a newly allocated list of strings, which should be `na_core_utils_slist_free()` by the caller, or `NULL` if the provided string was not of the MateConf form.

Since 2.30

### na_mateconf_utils_slist_to_string ()

    gchar *             na_mateconf_utils_slist_to_string      (GSList *slist);

### Warning

`na_mateconf_utils_slist_to_string` is deprecated and should not be used in newly-written code. 3.1

`slist` : | a GSList to be displayed.
Returns : | the content of `slist`, with the MateConf format, as a newly allocated string which should be `g_free()` by the caller.

Since 2.30