![]() |
![]() |
![]() |
GPE libcontactsdb Reference Manual | |
---|---|---|---|---|
#define CONFIG_PANEL #define CONFIG_LIST int db_open (gboolean open_vcard); int contacts_db_open (gboolean open_vcard); int contacts_db_close (void); struct contacts_tag_value; struct contacts_tag_value* contacts_new_tag_value (gchar*, gchar*); void contacts_free_tag_values (GSList*); void contacts_update_tag_value (struct contacts_tag_value *t, gchar *value); struct contacts_person; struct contacts_person* contacts_new_person (void); gboolean contacts_commit_person (struct contacts_person*); void contacts_discard_person (struct contacts_person*); void contacts_db_set_data (struct contacts_person*, gchar *tag, gchar *value); struct contacts_tag_value* contacts_db_find_tag (struct contacts_person *p, gchar *tag); GSList* contacts_db_get_entries (void); GSList* contacts_db_get_entries_finddlg (const gchar *str, const gchar *cat); GSList* contacts_db_get_entries_list (const gchar *name, const gchar *cat); GSList* contacts_db_get_entries_list_filtered (const gchar *str, const gchar *filter, const gchar *cat); struct contacts_person* contacts_db_get_by_uid (guint uid); gboolean contacts_db_delete_by_uid (guint uid); void contacts_db_set_multi_data (struct contacts_person *p, gchar *tag, gchar *value); void contacts_db_delete_tag (struct contacts_person *p, gchar *tag); gint contacts_db_get_tag_list (gchar ***list); gint contacts_db_get_config_values (gint group, gchar ***list); void contacts_db_add_config_values (gint group, gchar *identifier, gchar *value); void contacts_db_delete_config_values (gint group, gchar *identifier); void contacts_db_update_config_values (gint group, gchar *identifier, gchar *value); gchar* contacts_db_get_config_tag (gint group, const gchar *tagname); void contacts_db_free_result (char **table); gint contacts_sort_entries (struct contacts_person *a, struct contacts_person *b); gchar* contacts_db_compress (void); gint contacts_db_size (void);
This section documents the GPE contacts database API. The current implementation of the database makes use of the SQLite in-process database engine for data storage.
struct contacts_tag_value* contacts_new_tag_value (gchar*, gchar*);
Param1 : |
|
Param2 : |
|
Returns : |
void contacts_update_tag_value (struct contacts_tag_value *t, gchar *value);
t : |
|
value : |
struct contacts_person { guint id; gchar *name; gchar *family_name; gchar *company; GSList *data; };
gboolean contacts_commit_person (struct contacts_person*);
Param1 : |
|
Returns : |
void contacts_db_set_data (struct contacts_person*, gchar *tag, gchar *value);
Param1 : |
|
tag : |
|
value : |
struct contacts_tag_value* contacts_db_find_tag (struct contacts_person *p, gchar *tag);
p : |
|
tag : |
|
Returns : |
GSList* contacts_db_get_entries_finddlg (const gchar *str, const gchar *cat);
str : |
|
cat : |
|
Returns : |
GSList* contacts_db_get_entries_list (const gchar *name, const gchar *cat);
name : |
|
cat : |
|
Returns : |
GSList* contacts_db_get_entries_list_filtered (const gchar *str, const gchar *filter, const gchar *cat);
str : |
|
filter : |
|
cat : |
|
Returns : |
struct contacts_person* contacts_db_get_by_uid (guint uid);
uid : |
|
Returns : |
void contacts_db_set_multi_data (struct contacts_person *p, gchar *tag, gchar *value);
p : |
|
tag : |
|
value : |
void contacts_db_delete_tag (struct contacts_person *p, gchar *tag);
p : |
|
tag : |
gint contacts_db_get_config_values (gint group, gchar ***list);
group : |
|
list : |
|
Returns : |
void contacts_db_add_config_values (gint group, gchar *identifier, gchar *value);
group : |
|
identifier : |
|
value : |
void contacts_db_delete_config_values (gint group, gchar *identifier);
group : |
|
identifier : |
void contacts_db_update_config_values (gint group, gchar *identifier, gchar *value);
group : |
|
identifier : |
|
value : |
gchar* contacts_db_get_config_tag (gint group, const gchar *tagname);
group : |
|
tagname : |
|
Returns : |
gint contacts_sort_entries (struct contacts_person *a, struct contacts_person *b);
a : |
|
b : |
|
Returns : |