Mercurial > audlegacy
annotate src/audacious/configdb.h @ 4433:a6a2e84e2b2e
Use mcs_handle_t directly instead of ConfigDb struct to remove the useless wrapper.
A compatibility #define alias for ConfigDb added in plugin.h, at least for now.
author | Matti Hamalainen <ccr@tnsp.org> |
---|---|
date | Wed, 09 Apr 2008 15:50:37 +0300 |
parents | 259b7d3e0976 |
children | 9c40eb4bc22d |
rev | line source |
---|---|
2313 | 1 #ifndef CONFIGDB_H |
2 #define CONFIGDB_H | |
3 | |
4 #include <glib.h> | |
5 | |
4433
a6a2e84e2b2e
Use mcs_handle_t directly instead of ConfigDb struct to remove the useless wrapper.
Matti Hamalainen <ccr@tnsp.org>
parents:
3686
diff
changeset
|
6 typedef struct mcs_handle_ mcs_handle_t; |
2313 | 7 |
8 G_BEGIN_DECLS | |
9 | |
10 /** | |
3686
259b7d3e0976
sed s/bmp_cfg_db/cfg_db/.
William Pitcock <nenolod@atheme.org>
parents:
3112
diff
changeset
|
11 * cfg_db_open: |
2313 | 12 * |
13 * Opens the configuration database. | |
14 * | |
15 * Return value: A configuration database handle. | |
16 **/ | |
4433
a6a2e84e2b2e
Use mcs_handle_t directly instead of ConfigDb struct to remove the useless wrapper.
Matti Hamalainen <ccr@tnsp.org>
parents:
3686
diff
changeset
|
17 mcs_handle_t *cfg_db_open(); |
2313 | 18 |
19 /** | |
3686
259b7d3e0976
sed s/bmp_cfg_db/cfg_db/.
William Pitcock <nenolod@atheme.org>
parents:
3112
diff
changeset
|
20 * cfg_db_close: |
2313 | 21 * @db: A configuration database handle. |
22 * | |
23 * Closes the configuration database. | |
24 **/ | |
4433
a6a2e84e2b2e
Use mcs_handle_t directly instead of ConfigDb struct to remove the useless wrapper.
Matti Hamalainen <ccr@tnsp.org>
parents:
3686
diff
changeset
|
25 void cfg_db_close(mcs_handle_t *db); |
2313 | 26 |
27 /** | |
3686
259b7d3e0976
sed s/bmp_cfg_db/cfg_db/.
William Pitcock <nenolod@atheme.org>
parents:
3112
diff
changeset
|
28 * cfg_db_get_string: |
2313 | 29 * @db: A configuration database handle. |
30 * @section: The section of the configuration database to search. | |
31 * @key: The name of the field in the configuration database to look up. | |
32 * @value: Pointer to a buffer to put the data in. | |
33 * | |
34 * Searches the configuration database for a value. | |
35 * | |
36 * Return value: TRUE if successful, FALSE otherwise. | |
37 **/ | |
4433
a6a2e84e2b2e
Use mcs_handle_t directly instead of ConfigDb struct to remove the useless wrapper.
Matti Hamalainen <ccr@tnsp.org>
parents:
3686
diff
changeset
|
38 gboolean cfg_db_get_string(mcs_handle_t *db, |
2313 | 39 const gchar *section, |
40 const gchar *key, | |
41 gchar **value); | |
42 | |
43 /** | |
3686
259b7d3e0976
sed s/bmp_cfg_db/cfg_db/.
William Pitcock <nenolod@atheme.org>
parents:
3112
diff
changeset
|
44 * cfg_db_get_int: |
2313 | 45 * @db: A configuration database handle. |
46 * @section: The section of the configuration database to search. | |
47 * @key: The name of the field in the configuration database to look up. | |
48 * @value: Pointer to an integer to put the data in. | |
49 * | |
50 * Searches the configuration database for a value. | |
51 * | |
52 * Return value: TRUE if successful, FALSE otherwise. | |
53 **/ | |
4433
a6a2e84e2b2e
Use mcs_handle_t directly instead of ConfigDb struct to remove the useless wrapper.
Matti Hamalainen <ccr@tnsp.org>
parents:
3686
diff
changeset
|
54 gboolean cfg_db_get_int(mcs_handle_t *db, |
2313 | 55 const gchar *section, |
56 const gchar *key, | |
57 gint *value); | |
58 | |
59 /** | |
3686
259b7d3e0976
sed s/bmp_cfg_db/cfg_db/.
William Pitcock <nenolod@atheme.org>
parents:
3112
diff
changeset
|
60 * cfg_db_get_bool: |
2313 | 61 * @db: A configuration database handle. |
62 * @section: The section of the configuration database to search. | |
63 * @key: The name of the field in the configuration database to look up. | |
64 * @value: Pointer to a boolean to put the data in. | |
65 * | |
66 * Searches the configuration database for a value. | |
67 * | |
68 * Return value: TRUE if successful, FALSE otherwise. | |
69 **/ | |
4433
a6a2e84e2b2e
Use mcs_handle_t directly instead of ConfigDb struct to remove the useless wrapper.
Matti Hamalainen <ccr@tnsp.org>
parents:
3686
diff
changeset
|
70 gboolean cfg_db_get_bool(mcs_handle_t *db, |
2313 | 71 const gchar *section, |
72 const gchar *key, | |
73 gboolean *value); | |
74 | |
75 /** | |
3686
259b7d3e0976
sed s/bmp_cfg_db/cfg_db/.
William Pitcock <nenolod@atheme.org>
parents:
3112
diff
changeset
|
76 * cfg_db_get_float: |
2313 | 77 * @db: A configuration database handle. |
78 * @section: The section of the configuration database to search. | |
79 * @key: The name of the field in the configuration database to look up. | |
80 * @value: Pointer to a floating point integer to put the data in. | |
81 * | |
82 * Searches the configuration database for a value. | |
83 * | |
84 * Return value: TRUE if successful, FALSE otherwise. | |
85 **/ | |
4433
a6a2e84e2b2e
Use mcs_handle_t directly instead of ConfigDb struct to remove the useless wrapper.
Matti Hamalainen <ccr@tnsp.org>
parents:
3686
diff
changeset
|
86 gboolean cfg_db_get_float(mcs_handle_t *db, |
2313 | 87 const gchar *section, |
88 const gchar *key, | |
89 gfloat *value); | |
90 | |
91 /** | |
3686
259b7d3e0976
sed s/bmp_cfg_db/cfg_db/.
William Pitcock <nenolod@atheme.org>
parents:
3112
diff
changeset
|
92 * cfg_db_get_double: |
2313 | 93 * @db: A configuration database handle. |
94 * @section: The section of the configuration database to search. | |
95 * @key: The name of the field in the configuration database to look up. | |
96 * @value: Pointer to a double-precision floating point integer to put the data in. | |
97 * | |
98 * Searches the configuration database for a value. | |
99 * | |
100 * Return value: TRUE if successful, FALSE otherwise. | |
101 **/ | |
4433
a6a2e84e2b2e
Use mcs_handle_t directly instead of ConfigDb struct to remove the useless wrapper.
Matti Hamalainen <ccr@tnsp.org>
parents:
3686
diff
changeset
|
102 gboolean cfg_db_get_double(mcs_handle_t *db, |
2313 | 103 const gchar *section, |
104 const gchar *key, | |
105 gdouble *value); | |
106 | |
107 /** | |
3686
259b7d3e0976
sed s/bmp_cfg_db/cfg_db/.
William Pitcock <nenolod@atheme.org>
parents:
3112
diff
changeset
|
108 * cfg_db_set_string: |
2313 | 109 * @db: A configuration database handle. |
110 * @section: The section of the configuration database to search. | |
111 * @key: The name of the field in the configuration database to set. | |
112 * @value: Pointer to a buffer containing the data. | |
113 * | |
114 * Sets a value in the configuration database. | |
115 **/ | |
4433
a6a2e84e2b2e
Use mcs_handle_t directly instead of ConfigDb struct to remove the useless wrapper.
Matti Hamalainen <ccr@tnsp.org>
parents:
3686
diff
changeset
|
116 void cfg_db_set_string(mcs_handle_t *db, |
2313 | 117 const gchar *section, |
118 const gchar *key, | |
2346
0b98ad8c8b17
[svn] removed xmms_create_dirbrowser, small config db fixes
mf0102
parents:
2313
diff
changeset
|
119 const gchar *value); |
2313 | 120 |
121 /** | |
3686
259b7d3e0976
sed s/bmp_cfg_db/cfg_db/.
William Pitcock <nenolod@atheme.org>
parents:
3112
diff
changeset
|
122 * cfg_db_set_int: |
2313 | 123 * @db: A configuration database handle. |
124 * @section: The section of the configuration database to search. | |
125 * @key: The name of the field in the configuration database to set. | |
126 * @value: Pointer to an integer containing the data. | |
127 * | |
128 * Sets a value in the configuration database. | |
129 **/ | |
4433
a6a2e84e2b2e
Use mcs_handle_t directly instead of ConfigDb struct to remove the useless wrapper.
Matti Hamalainen <ccr@tnsp.org>
parents:
3686
diff
changeset
|
130 void cfg_db_set_int(mcs_handle_t *db, |
2313 | 131 const gchar *section, |
132 const gchar *key, | |
133 gint value); | |
134 | |
135 /** | |
3686
259b7d3e0976
sed s/bmp_cfg_db/cfg_db/.
William Pitcock <nenolod@atheme.org>
parents:
3112
diff
changeset
|
136 * cfg_db_set_bool: |
2313 | 137 * @db: A configuration database handle. |
138 * @section: The section of the configuration database to search. | |
139 * @key: The name of the field in the configuration database to set. | |
140 * @value: Pointer to a boolean containing the data. | |
141 * | |
142 * Sets a value in the configuration database. | |
143 **/ | |
4433
a6a2e84e2b2e
Use mcs_handle_t directly instead of ConfigDb struct to remove the useless wrapper.
Matti Hamalainen <ccr@tnsp.org>
parents:
3686
diff
changeset
|
144 void cfg_db_set_bool(mcs_handle_t *db, |
2313 | 145 const gchar *section, |
146 const gchar *key, | |
147 gboolean value); | |
148 | |
149 /** | |
3686
259b7d3e0976
sed s/bmp_cfg_db/cfg_db/.
William Pitcock <nenolod@atheme.org>
parents:
3112
diff
changeset
|
150 * cfg_db_set_float: |
2313 | 151 * @db: A configuration database handle. |
152 * @section: The section of the configuration database to search. | |
153 * @key: The name of the field in the configuration database to set. | |
154 * @value: Pointer to a floating point integer containing the data. | |
155 * | |
156 * Sets a value in the configuration database. | |
157 **/ | |
4433
a6a2e84e2b2e
Use mcs_handle_t directly instead of ConfigDb struct to remove the useless wrapper.
Matti Hamalainen <ccr@tnsp.org>
parents:
3686
diff
changeset
|
158 void cfg_db_set_float(mcs_handle_t *db, |
2313 | 159 const gchar *section, |
160 const gchar *key, | |
161 gfloat value); | |
162 | |
163 /** | |
3686
259b7d3e0976
sed s/bmp_cfg_db/cfg_db/.
William Pitcock <nenolod@atheme.org>
parents:
3112
diff
changeset
|
164 * cfg_db_set_double: |
2313 | 165 * @db: A configuration database handle. |
166 * @section: The section of the configuration database to search. | |
167 * @key: The name of the field in the configuration database to set. | |
168 * @value: Pointer to a double precision floating point integer containing the data. | |
169 * | |
170 * Sets a value in the configuration database. | |
171 **/ | |
4433
a6a2e84e2b2e
Use mcs_handle_t directly instead of ConfigDb struct to remove the useless wrapper.
Matti Hamalainen <ccr@tnsp.org>
parents:
3686
diff
changeset
|
172 void cfg_db_set_double(mcs_handle_t *db, |
2313 | 173 const gchar *section, |
174 const gchar *key, | |
175 gdouble value); | |
176 | |
177 /** | |
3686
259b7d3e0976
sed s/bmp_cfg_db/cfg_db/.
William Pitcock <nenolod@atheme.org>
parents:
3112
diff
changeset
|
178 * cfg_db_unset_key: |
2313 | 179 * @db: A configuration database handle. |
180 * @section: The section of the configuration database to search. | |
181 * @key: The name of the field in the configuration database to set. | |
182 * | |
183 * Removes a value from the configuration database. | |
184 **/ | |
4433
a6a2e84e2b2e
Use mcs_handle_t directly instead of ConfigDb struct to remove the useless wrapper.
Matti Hamalainen <ccr@tnsp.org>
parents:
3686
diff
changeset
|
185 void cfg_db_unset_key(mcs_handle_t *db, |
2313 | 186 const gchar *section, |
187 const gchar *key); | |
188 | |
189 G_END_DECLS | |
190 | |
2521 | 191 #endif /* CONFIGDB_H */ |
2313 | 192 |