1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>config</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="libuser Reference Manual">
<link rel="up" href="ch01.html" title="libuser">
<link rel="prev" href="ch01.html" title="libuser">
<link rel="next" href="libuser-value.html" title="value">
<meta name="generator" content="GTK-Doc V1.9 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="libuser">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="ch01.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libuser Reference Manual</th>
<td><a accesskey="n" href="libuser-value.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id3067245" class="shortcut">Top</a>
 | 
<a href="#id3029390" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="libuser-config"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id3067245"></a><span class="refentrytitle">config</span>
</h2>
<p>config — Routines for reading configuration information for the libuser library.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
<a
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
>GList</a>* <a class="link" href="libuser-config.html#lu-cfg-read">lu_cfg_read</a> (struct lu_context *context,
const char *key,
const char *default_value);
const char* <a class="link" href="libuser-config.html#lu-cfg-read-single">lu_cfg_read_single</a> (struct lu_context *context,
const char *key,
const char *default_value);
<a
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
>GList</a>* <a class="link" href="libuser-config.html#lu-cfg-read-keys">lu_cfg_read_keys</a> (struct lu_context *context,
const char *parent_key);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id3029390"></a><h2>Description</h2>
<p>
These routines allow an application or module to read configuration data
from the libuser configuration.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id3029407"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id3029417"></a><h3>
<a name="lu-cfg-read"></a>lu_cfg_read ()</h3>
<a class="indexterm" name="id3029429"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
>GList</a>* lu_cfg_read (struct lu_context *context,
const char *key,
const char *default_value);</pre>
<p>
Reads the list of values for a given key from the configuration space.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td>
<td>A valid libuser library context.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>The value to be read from the configuration. The key should be of the
form "section/key" for most purposes. For example, the <span class="type">files</span> module uses
keys of the form "file/foo" for all of its configuration data.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>default_value</code></em> :</span></p></td>
<td>A default value to be returned in case none are found. Can
be NULL.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A <a
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
><span class="type">GList</span></a> of values, formatted as strings. The list must be freed
by calling <a
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#g-list-free"
><code class="function">g_list_free()</code></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3076559"></a><h3>
<a name="lu-cfg-read-single"></a>lu_cfg_read_single ()</h3>
<a class="indexterm" name="id3076569"></a><pre class="programlisting">const char* lu_cfg_read_single (struct lu_context *context,
const char *key,
const char *default_value);</pre>
<p>
Read a single value set for a given key in the configuration space. This is
a convenience function.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td>
<td>A valid libuser library context.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>The value to be read from the configuration. The key should be of the
form "section/key" for most purposes. For example, the <span class="type">files</span> module uses
keys of the form "file/foo" for all of its configuration data.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>default_value</code></em> :</span></p></td>
<td>A default value to be returned in case none are found. Can
be NULL.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A string representation of one of the values set for the key. This
string must not be freed.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id3076674"></a><h3>
<a name="lu-cfg-read-keys"></a>lu_cfg_read_keys ()</h3>
<a class="indexterm" name="id3076684"></a><pre class="programlisting"><a
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
>GList</a>* lu_cfg_read_keys (struct lu_context *context,
const char *parent_key);</pre>
<p>
Read the names of all of the keys "below" a given key in the configuration
space. This function is typically used for walking the configuration space.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>context</code></em> :</span></p></td>
<td>A valid libuser library context.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>parent_key</code></em> :</span></p></td>
<td>The parent key under which the caller wishes to know which subkeys
are present.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A <a
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
><span class="type">GList</span></a> of string representations of key names. The list must be
freed using <a
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#g-list-free"
><code class="function">g_list_free()</code></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id3076775"></a><div class="refsect2" lang="en"><a name="id3076776"></a></div>
<hr>
<div class="refsect2" lang="en"><a name="id3076777"></a></div>
</div>
</div>
</body>
</html>
|
