annotate doc/libaudacious/tmpl/configdb.sgml @ 2746:2f5b461118a8 trunk

[svn] - adjust build order for libaudclient and audacious. reported by Crazy_Hopper.
author nenolod
date Fri, 11 May 2007 19:31:07 -0700
parents 53a3d5db6b58
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2034
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
1 <!-- ##### SECTION Title ##### -->
2049
5cf8de9f2c28 [svn] - document ConfigDB.
nenolod
parents: 2034
diff changeset
2 ConfigDB
2034
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
3
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
4 <!-- ##### SECTION Short_Description ##### -->
2049
5cf8de9f2c28 [svn] - document ConfigDB.
nenolod
parents: 2034
diff changeset
5 The audacious configuration database.
2034
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
6
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
7 <!-- ##### SECTION Long_Description ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
8 <para>
2060
53a3d5db6b58 [svn] - finish documenting the libaudacious API
nenolod
parents: 2049
diff changeset
9 The configuration database is used to store settings used by Audacious and it's plugins.
2034
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
10 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
11
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
12 <!-- ##### SECTION See_Also ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
13 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
14
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
15 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
16
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
17 <!-- ##### SECTION Stability_Level ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
18
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
19
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
20 <!-- ##### STRUCT ConfigDb ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
21 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
22
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
23 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
24
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
25
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
26 <!-- ##### FUNCTION bmp_cfg_db_open ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
27 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
28
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
29 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
30
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
31 @Returns:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
32
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
33
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
34 <!-- ##### FUNCTION bmp_cfg_db_close ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
35 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
36
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
37 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
38
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
39 @db:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
40
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
41
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
42 <!-- ##### FUNCTION bmp_cfg_db_get_string ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
43 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
44
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
45 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
46
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
47 @db:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
48 @section:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
49 @key:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
50 @value:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
51 @Returns:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
52
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
53
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
54 <!-- ##### FUNCTION bmp_cfg_db_get_int ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
55 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
56
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
57 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
58
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
59 @db:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
60 @section:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
61 @key:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
62 @value:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
63 @Returns:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
64
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
65
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
66 <!-- ##### FUNCTION bmp_cfg_db_get_bool ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
67 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
68
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
69 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
70
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
71 @db:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
72 @section:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
73 @key:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
74 @value:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
75 @Returns:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
76
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
77
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
78 <!-- ##### FUNCTION bmp_cfg_db_get_float ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
79 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
80
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
81 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
82
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
83 @db:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
84 @section:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
85 @key:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
86 @value:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
87 @Returns:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
88
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
89
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
90 <!-- ##### FUNCTION bmp_cfg_db_get_double ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
91 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
92
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
93 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
94
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
95 @db:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
96 @section:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
97 @key:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
98 @value:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
99 @Returns:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
100
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
101
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
102 <!-- ##### FUNCTION bmp_cfg_db_set_string ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
103 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
104
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
105 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
106
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
107 @db:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
108 @section:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
109 @key:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
110 @value:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
111
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
112
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
113 <!-- ##### FUNCTION bmp_cfg_db_set_int ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
114 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
115
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
116 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
117
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
118 @db:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
119 @section:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
120 @key:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
121 @value:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
122
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
123
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
124 <!-- ##### FUNCTION bmp_cfg_db_set_bool ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
125 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
126
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
127 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
128
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
129 @db:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
130 @section:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
131 @key:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
132 @value:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
133
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
134
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
135 <!-- ##### FUNCTION bmp_cfg_db_set_float ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
136 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
137
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
138 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
139
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
140 @db:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
141 @section:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
142 @key:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
143 @value:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
144
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
145
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
146 <!-- ##### FUNCTION bmp_cfg_db_set_double ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
147 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
148
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
149 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
150
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
151 @db:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
152 @section:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
153 @key:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
154 @value:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
155
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
156
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
157 <!-- ##### FUNCTION bmp_cfg_db_unset_key ##### -->
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
158 <para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
159
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
160 </para>
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
161
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
162 @db:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
163 @section:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
164 @key:
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
165
c43fb0845b71 [svn] - update VFS documentation
nenolod
parents:
diff changeset
166