|
Server : Apache/2.2.17 (Unix) mod_ssl/2.2.17 OpenSSL/0.9.8e-fips-rhel5 DAV/2 PHP/5.2.17 System : Linux localhost 2.6.18-419.el5 #1 SMP Fri Feb 24 22:47:42 UTC 2017 x86_64 User : nobody ( 99) PHP Version : 5.2.17 Disable Function : NONE Directory : /usr/share/gtk-doc/html/libuser/ |
Upload File : |
<!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.69.1">
<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.6 (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="#top_of_page" class="shortcut">Top</a>
 | 
<a href="#desc" 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><span class="refentrytitle"><a name="top_of_page"></a>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">
<a name="synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
<a
href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"
>GList</a>* <a 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 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 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="desc"></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="details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id2518873"></a><h3>
<a name="lu-cfg-read"></a>lu_cfg_read ()</h3>
<a class="indexterm" name="id2518884"></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>
<span class="term"><em class="parameter"><code>context</code></em> :</span></td>
<td>A valid libuser library context.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>key</code></em> :</span></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>
<span class="term"><em class="parameter"><code>default_value</code></em> :</span></td>
<td>A default value to be returned in case none are found. Can
be NULL.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></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="id2563613"></a><h3>
<a name="lu-cfg-read-single"></a>lu_cfg_read_single ()</h3>
<a class="indexterm" name="id2563626"></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>
<span class="term"><em class="parameter"><code>context</code></em> :</span></td>
<td>A valid libuser library context.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>key</code></em> :</span></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>
<span class="term"><em class="parameter"><code>default_value</code></em> :</span></td>
<td>A default value to be returned in case none are found. Can
be NULL.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></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="id2563742"></a><h3>
<a name="lu-cfg-read-keys"></a>lu_cfg_read_keys ()</h3>
<a class="indexterm" name="id2563754"></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>
<span class="term"><em class="parameter"><code>context</code></em> :</span></td>
<td>A valid libuser library context.
</td>
</tr>
<tr>
<td>
<span class="term"><em class="parameter"><code>parent_key</code></em> :</span></td>
<td>The parent key under which the caller wishes to know which subkeys
are present.
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></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>
</body>
</html>