| 1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| 2 |
<html> |
| 3 |
<head> |
| 4 |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| 5 |
<title>OobsUsersConfig</title> |
| 6 |
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2"> |
| 7 |
<link rel="home" href="index.html" title="Liboobs (System configuration management) Reference Manual"> |
| 8 |
<link rel="up" href="ch02.html" title="Users and groups management"> |
| 9 |
<link rel="prev" href="OobsGroupsConfig.html" title="OobsGroupsConfig"> |
| 10 |
<link rel="next" href="OobsSelfConfig.html" title="OobsSelfConfig"> |
| 11 |
<meta name="generator" content="GTK-Doc V1.15 (XML mode)"> |
| 12 |
<link rel="stylesheet" href="style.css" type="text/css"> |
| 13 |
</head> |
| 14 |
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> |
| 15 |
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"> |
| 16 |
<tr valign="middle"> |
| 17 |
<td><a accesskey="p" href="OobsGroupsConfig.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> |
| 18 |
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> |
| 19 |
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> |
| 20 |
<th width="100%" align="center">Liboobs (System configuration management) Reference Manual</th> |
| 21 |
<td><a accesskey="n" href="OobsSelfConfig.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> |
| 22 |
</tr> |
| 23 |
<tr><td colspan="5" class="shortcuts"> |
| 24 |
<a href="#OobsUsersConfig.synopsis" class="shortcut">Top</a> |
| 25 |
| |
| 26 |
<a href="#OobsUsersConfig.description" class="shortcut">Description</a> |
| 27 |
| |
| 28 |
<a href="#OobsUsersConfig.object-hierarchy" class="shortcut">Object Hierarchy</a> |
| 29 |
| |
| 30 |
<a href="#OobsUsersConfig.properties" class="shortcut">Properties</a> |
| 31 |
</td></tr> |
| 32 |
</table> |
| 33 |
<div class="refentry" title="OobsUsersConfig"> |
| 34 |
<a name="OobsUsersConfig"></a><div class="titlepage"></div> |
| 35 |
<div class="refnamediv"><table width="100%"><tr> |
| 36 |
<td valign="top"> |
| 37 |
<h2><span class="refentrytitle"><a name="OobsUsersConfig.top_of_page"></a>OobsUsersConfig</span></h2> |
| 38 |
<p>OobsUsersConfig — Object that represents users configuration</p> |
| 39 |
</td> |
| 40 |
<td valign="top" align="right"></td> |
| 41 |
</tr></table></div> |
| 42 |
<div class="refsynopsisdiv" title="Synopsis"> |
| 43 |
<a name="OobsUsersConfig.synopsis"></a><h2>Synopsis</h2> |
| 44 |
<pre class="synopsis"> <a class="link" href="OobsUsersConfig.html#OobsUsersConfig-struct" title="OobsUsersConfig">OobsUsersConfig</a>; |
| 45 |
<a class="link" href="OobsUsersConfig.html#OobsUsersConfigClass" title="OobsUsersConfigClass">OobsUsersConfigClass</a>; |
| 46 |
<a class="link" href="OobsObject.html" title="OobsObject"><span class="returnvalue">OobsObject</span></a>* <a class="link" href="OobsUsersConfig.html#oobs-users-config-get" title="oobs_users_config_get ()">oobs_users_config_get</a> (<em class="parameter"><code><span class="type">void</span></code></em>); |
| 47 |
<a class="link" href="OobsList.html" title="OobsList"><span class="returnvalue">OobsList</span></a>* <a class="link" href="OobsUsersConfig.html#oobs-users-config-get-users" title="oobs_users_config_get_users ()">oobs_users_config_get_users</a> (<em class="parameter"><code><a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a> *config</code></em>); |
| 48 |
<span class="returnvalue">OobsResult</span> <a class="link" href="OobsUsersConfig.html#oobs-users-config-add-user" title="oobs_users_config_add_user ()">oobs_users_config_add_user</a> (<em class="parameter"><code><a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a> *config</code></em>, |
| 49 |
<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>); |
| 50 |
<span class="returnvalue">OobsResult</span> <a class="link" href="OobsUsersConfig.html#oobs-users-config-delete-user" title="oobs_users_config_delete_user ()">oobs_users_config_delete_user</a> (<em class="parameter"><code><a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a> *config</code></em>, |
| 51 |
<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>); |
| 52 |
<span class="returnvalue">uid_t</span> <a class="link" href="OobsUsersConfig.html#oobs-users-config-get-minimum-users-uid" title="oobs_users_config_get_minimum_users_uid ()">oobs_users_config_get_minimum_users_uid</a> |
| 53 |
(<em class="parameter"><code><a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a> *config</code></em>); |
| 54 |
<span class="returnvalue">void</span> <a class="link" href="OobsUsersConfig.html#oobs-users-config-set-minimum-users-uid" title="oobs_users_config_set_minimum_users_uid ()">oobs_users_config_set_minimum_users_uid</a> |
| 55 |
(<em class="parameter"><code><a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a> *config</code></em>, |
| 56 |
<em class="parameter"><code><span class="type">uid_t</span> uid</code></em>); |
| 57 |
<span class="returnvalue">uid_t</span> <a class="link" href="OobsUsersConfig.html#oobs-users-config-get-maximum-users-uid" title="oobs_users_config_get_maximum_users_uid ()">oobs_users_config_get_maximum_users_uid</a> |
| 58 |
(<em class="parameter"><code><a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a> *config</code></em>); |
| 59 |
<span class="returnvalue">void</span> <a class="link" href="OobsUsersConfig.html#oobs-users-config-set-maximum-users-uid" title="oobs_users_config_set_maximum_users_uid ()">oobs_users_config_set_maximum_users_uid</a> |
| 60 |
(<em class="parameter"><code><a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a> *config</code></em>, |
| 61 |
<em class="parameter"><code><span class="type">uid_t</span> uid</code></em>); |
| 62 |
const <span class="returnvalue">gchar</span>* <a class="link" href="OobsUsersConfig.html#oobs-users-config-get-default-shell" title="oobs_users_config_get_default_shell ()">oobs_users_config_get_default_shell</a> (<em class="parameter"><code><a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a> *config</code></em>); |
| 63 |
<span class="returnvalue">void</span> <a class="link" href="OobsUsersConfig.html#oobs-users-config-set-default-shell" title="oobs_users_config_set_default_shell ()">oobs_users_config_set_default_shell</a> (<em class="parameter"><code><a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a> *config</code></em>, |
| 64 |
<em class="parameter"><code>const <span class="type">gchar</span> *shell</code></em>); |
| 65 |
const <span class="returnvalue">gchar</span>* <a class="link" href="OobsUsersConfig.html#oobs-users-config-get-default-home-dir" title="oobs_users_config_get_default_home_dir ()">oobs_users_config_get_default_home_dir</a> |
| 66 |
(<em class="parameter"><code><a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a> *config</code></em>); |
| 67 |
<span class="returnvalue">void</span> <a class="link" href="OobsUsersConfig.html#oobs-users-config-set-default-home-dir" title="oobs_users_config_set_default_home_dir ()">oobs_users_config_set_default_home_dir</a> |
| 68 |
(<em class="parameter"><code><a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a> *config</code></em>, |
| 69 |
<em class="parameter"><code>const <span class="type">gchar</span> *home_dir</code></em>); |
| 70 |
<a class="link" href="OobsGroup.html" title="OobsGroup"><span class="returnvalue">OobsGroup</span></a>* <a class="link" href="OobsUsersConfig.html#oobs-users-config-get-default-group" title="oobs_users_config_get_default_group ()">oobs_users_config_get_default_group</a> (<em class="parameter"><code><a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a> *config</code></em>); |
| 71 |
<span class="returnvalue">GList</span>* <a class="link" href="OobsUsersConfig.html#oobs-users-config-get-available-shells" title="oobs_users_config_get_available_shells ()">oobs_users_config_get_available_shells</a> |
| 72 |
(<em class="parameter"><code><a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a> *config</code></em>); |
| 73 |
<span class="returnvalue">gboolean</span> <a class="link" href="OobsUsersConfig.html#oobs-users-config-get-encrypted-home-support" title="oobs_users_config_get_encrypted_home_support ()">oobs_users_config_get_encrypted_home_support</a> |
| 74 |
(<em class="parameter"><code><a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a> *config</code></em>); |
| 75 |
<span class="returnvalue">GList</span>* <a class="link" href="OobsUsersConfig.html#oobs-users-config-get-available-locales" title="oobs_users_config_get_available_locales ()">oobs_users_config_get_available_locales</a> |
| 76 |
(<em class="parameter"><code><a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a> *config</code></em>); |
| 77 |
<a class="link" href="OobsUser.html" title="OobsUser"><span class="returnvalue">OobsUser</span></a>* <a class="link" href="OobsUsersConfig.html#oobs-users-config-get-from-login" title="oobs_users_config_get_from_login ()">oobs_users_config_get_from_login</a> (<em class="parameter"><code><a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a> *config</code></em>, |
| 78 |
<em class="parameter"><code>const <span class="type">gchar</span> *login</code></em>); |
| 79 |
<a class="link" href="OobsUser.html" title="OobsUser"><span class="returnvalue">OobsUser</span></a>* <a class="link" href="OobsUsersConfig.html#oobs-users-config-get-from-uid" title="oobs_users_config_get_from_uid ()">oobs_users_config_get_from_uid</a> (<em class="parameter"><code><a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a> *config</code></em>, |
| 80 |
<em class="parameter"><code><span class="type">uid_t</span> uid</code></em>); |
| 81 |
<span class="returnvalue">gboolean</span> <a class="link" href="OobsUsersConfig.html#oobs-users-config-is-login-used" title="oobs_users_config_is_login_used ()">oobs_users_config_is_login_used</a> (<em class="parameter"><code><a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a> *config</code></em>, |
| 82 |
<em class="parameter"><code>const <span class="type">gchar</span> *login</code></em>); |
| 83 |
<span class="returnvalue">gboolean</span> <a class="link" href="OobsUsersConfig.html#oobs-users-config-is-uid-used" title="oobs_users_config_is_uid_used ()">oobs_users_config_is_uid_used</a> (<em class="parameter"><code><a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a> *config</code></em>, |
| 84 |
<em class="parameter"><code><span class="type">uid_t</span> uid</code></em>); |
| 85 |
<span class="returnvalue">uid_t</span> <a class="link" href="OobsUsersConfig.html#oobs-users-config-find-free-uid" title="oobs_users_config_find_free_uid ()">oobs_users_config_find_free_uid</a> (<em class="parameter"><code><a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a> *config</code></em>, |
| 86 |
<em class="parameter"><code><span class="type">uid_t</span> uid_min</code></em>, |
| 87 |
<em class="parameter"><code><span class="type">uid_t</span> uid_max</code></em>); |
| 88 |
</pre> |
| 89 |
</div> |
| 90 |
<div class="refsect1" title="Object Hierarchy"> |
| 91 |
<a name="OobsUsersConfig.object-hierarchy"></a><h2>Object Hierarchy</h2> |
| 92 |
<pre class="synopsis"> |
| 93 |
GObject |
| 94 |
+----<a class="link" href="OobsObject.html" title="OobsObject">OobsObject</a> |
| 95 |
+----OobsUsersConfig |
| 96 |
</pre> |
| 97 |
</div> |
| 98 |
<div class="refsect1" title="Properties"> |
| 99 |
<a name="OobsUsersConfig.properties"></a><h2>Properties</h2> |
| 100 |
<pre class="synopsis"> |
| 101 |
"<a class="link" href="OobsUsersConfig.html#OobsUsersConfig--default-group" title='The "default-group" property'>default-group</a>" <a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a>* : Read |
| 102 |
"<a class="link" href="OobsUsersConfig.html#OobsUsersConfig--default-home" title='The "default-home" property'>default-home</a>" <span class="type">gchar</span>* : Read / Write |
| 103 |
"<a class="link" href="OobsUsersConfig.html#OobsUsersConfig--default-shell" title='The "default-shell" property'>default-shell</a>" <span class="type">gchar</span>* : Read / Write |
| 104 |
"<a class="link" href="OobsUsersConfig.html#OobsUsersConfig--encrypted-home" title='The "encrypted-home" property'>encrypted-home</a>" <span class="type">gboolean</span> : Read |
| 105 |
"<a class="link" href="OobsUsersConfig.html#OobsUsersConfig--maximum-uid" title='The "maximum-uid" property'>maximum-uid</a>" <span class="type">guint</span> : Read / Write |
| 106 |
"<a class="link" href="OobsUsersConfig.html#OobsUsersConfig--minimum-uid" title='The "minimum-uid" property'>minimum-uid</a>" <span class="type">guint</span> : Read / Write |
| 107 |
</pre> |
| 108 |
</div> |
| 109 |
<div class="refsect1" title="Description"> |
| 110 |
<a name="OobsUsersConfig.description"></a><h2>Description</h2> |
| 111 |
</div> |
| 112 |
<div class="refsect1" title="Details"> |
| 113 |
<a name="OobsUsersConfig.details"></a><h2>Details</h2> |
| 114 |
<div class="refsect2" title="OobsUsersConfig"> |
| 115 |
<a name="OobsUsersConfig-struct"></a><h3>OobsUsersConfig</h3> |
| 116 |
<pre class="programlisting">typedef struct _OobsUsersConfig OobsUsersConfig;</pre> |
| 117 |
<p> |
| 118 |
</p> |
| 119 |
</div> |
| 120 |
<hr> |
| 121 |
<div class="refsect2" title="OobsUsersConfigClass"> |
| 122 |
<a name="OobsUsersConfigClass"></a><h3>OobsUsersConfigClass</h3> |
| 123 |
<pre class="programlisting">typedef struct { |
| 124 |
OobsObjectClass parent_class; |
| 125 |
|
| 126 |
void (*_oobs_padding1) (void); |
| 127 |
void (*_oobs_padding2) (void); |
| 128 |
void (*_oobs_padding3) (void); |
| 129 |
void (*_oobs_padding4) (void); |
| 130 |
} OobsUsersConfigClass; |
| 131 |
</pre> |
| 132 |
<p> |
| 133 |
</p> |
| 134 |
</div> |
| 135 |
<hr> |
| 136 |
<div class="refsect2" title="oobs_users_config_get ()"> |
| 137 |
<a name="oobs-users-config-get"></a><h3>oobs_users_config_get ()</h3> |
| 138 |
<pre class="programlisting"><a class="link" href="OobsObject.html" title="OobsObject"><span class="returnvalue">OobsObject</span></a>* oobs_users_config_get (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> |
| 139 |
<p> |
| 140 |
Returns the <a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a> singleton, which represents |
| 141 |
the system users and their configuration. |
| 142 |
</p> |
| 143 |
<div class="variablelist"><table border="0"> |
| 144 |
<col align="left" valign="top"> |
| 145 |
<tbody><tr> |
| 146 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 147 |
<td> the singleton <a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a> object. |
| 148 |
</td> |
| 149 |
</tr></tbody> |
| 150 |
</table></div> |
| 151 |
</div> |
| 152 |
<hr> |
| 153 |
<div class="refsect2" title="oobs_users_config_get_users ()"> |
| 154 |
<a name="oobs-users-config-get-users"></a><h3>oobs_users_config_get_users ()</h3> |
| 155 |
<pre class="programlisting"><a class="link" href="OobsList.html" title="OobsList"><span class="returnvalue">OobsList</span></a>* oobs_users_config_get_users (<em class="parameter"><code><a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a> *config</code></em>);</pre> |
| 156 |
<p> |
| 157 |
Returns an <a class="link" href="OobsList.html" title="OobsList"><span class="type">OobsList</span></a> containing objects of type <a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a>. |
| 158 |
</p> |
| 159 |
<div class="variablelist"><table border="0"> |
| 160 |
<col align="left" valign="top"> |
| 161 |
<tbody> |
| 162 |
<tr> |
| 163 |
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td> |
| 164 |
<td>An <a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a>. |
| 165 |
</td> |
| 166 |
</tr> |
| 167 |
<tr> |
| 168 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 169 |
<td> an <a class="link" href="OobsList.html" title="OobsList"><span class="type">OobsList</span></a> containing the system users. |
| 170 |
</td> |
| 171 |
</tr> |
| 172 |
</tbody> |
| 173 |
</table></div> |
| 174 |
</div> |
| 175 |
<hr> |
| 176 |
<div class="refsect2" title="oobs_users_config_add_user ()"> |
| 177 |
<a name="oobs-users-config-add-user"></a><h3>oobs_users_config_add_user ()</h3> |
| 178 |
<pre class="programlisting"><span class="returnvalue">OobsResult</span> oobs_users_config_add_user (<em class="parameter"><code><a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a> *config</code></em>, |
| 179 |
<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>);</pre> |
| 180 |
<p> |
| 181 |
Add an user to the configuration, immediately committing changes to the system. |
| 182 |
On success, <em class="parameter"><code>user</code></em> will be appended to the users list. |
| 183 |
</p> |
| 184 |
<div class="variablelist"><table border="0"> |
| 185 |
<col align="left" valign="top"> |
| 186 |
<tbody> |
| 187 |
<tr> |
| 188 |
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td> |
| 189 |
<td>An <a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a>. |
| 190 |
</td> |
| 191 |
</tr> |
| 192 |
<tr> |
| 193 |
<td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td> |
| 194 |
<td>An <a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a>. |
| 195 |
</td> |
| 196 |
</tr> |
| 197 |
<tr> |
| 198 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 199 |
<td> an <span class="type">OobsResult</span> enum with the error code. |
| 200 |
</td> |
| 201 |
</tr> |
| 202 |
</tbody> |
| 203 |
</table></div> |
| 204 |
</div> |
| 205 |
<hr> |
| 206 |
<div class="refsect2" title="oobs_users_config_delete_user ()"> |
| 207 |
<a name="oobs-users-config-delete-user"></a><h3>oobs_users_config_delete_user ()</h3> |
| 208 |
<pre class="programlisting"><span class="returnvalue">OobsResult</span> oobs_users_config_delete_user (<em class="parameter"><code><a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a> *config</code></em>, |
| 209 |
<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>);</pre> |
| 210 |
<p> |
| 211 |
Delete an user from the configuration, immediately committing changes to the system. |
| 212 |
On success, <em class="parameter"><code>user</code></em> will be removed from the users list. |
| 213 |
</p> |
| 214 |
<div class="variablelist"><table border="0"> |
| 215 |
<col align="left" valign="top"> |
| 216 |
<tbody> |
| 217 |
<tr> |
| 218 |
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td> |
| 219 |
<td>An <a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a>. |
| 220 |
</td> |
| 221 |
</tr> |
| 222 |
<tr> |
| 223 |
<td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td> |
| 224 |
<td>An <a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a>. |
| 225 |
</td> |
| 226 |
</tr> |
| 227 |
<tr> |
| 228 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 229 |
<td> an <span class="type">OobsResult</span> enum with the error code. |
| 230 |
</td> |
| 231 |
</tr> |
| 232 |
</tbody> |
| 233 |
</table></div> |
| 234 |
</div> |
| 235 |
<hr> |
| 236 |
<div class="refsect2" title="oobs_users_config_get_minimum_users_uid ()"> |
| 237 |
<a name="oobs-users-config-get-minimum-users-uid"></a><h3>oobs_users_config_get_minimum_users_uid ()</h3> |
| 238 |
<pre class="programlisting"><span class="returnvalue">uid_t</span> oobs_users_config_get_minimum_users_uid |
| 239 |
(<em class="parameter"><code><a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a> *config</code></em>);</pre> |
| 240 |
<p> |
| 241 |
Returns the default minimum UID for non-system users. |
| 242 |
</p> |
| 243 |
<div class="variablelist"><table border="0"> |
| 244 |
<col align="left" valign="top"> |
| 245 |
<tbody> |
| 246 |
<tr> |
| 247 |
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td> |
| 248 |
<td>An <a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a>. |
| 249 |
</td> |
| 250 |
</tr> |
| 251 |
<tr> |
| 252 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 253 |
<td> minimum UID for non-system users. |
| 254 |
</td> |
| 255 |
</tr> |
| 256 |
</tbody> |
| 257 |
</table></div> |
| 258 |
</div> |
| 259 |
<hr> |
| 260 |
<div class="refsect2" title="oobs_users_config_set_minimum_users_uid ()"> |
| 261 |
<a name="oobs-users-config-set-minimum-users-uid"></a><h3>oobs_users_config_set_minimum_users_uid ()</h3> |
| 262 |
<pre class="programlisting"><span class="returnvalue">void</span> oobs_users_config_set_minimum_users_uid |
| 263 |
(<em class="parameter"><code><a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a> *config</code></em>, |
| 264 |
<em class="parameter"><code><span class="type">uid_t</span> uid</code></em>);</pre> |
| 265 |
<p> |
| 266 |
Sets the minimum UID for non-system users. |
| 267 |
</p> |
| 268 |
<div class="variablelist"><table border="0"> |
| 269 |
<col align="left" valign="top"> |
| 270 |
<tbody> |
| 271 |
<tr> |
| 272 |
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td> |
| 273 |
<td>An <a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a>. |
| 274 |
</td> |
| 275 |
</tr> |
| 276 |
<tr> |
| 277 |
<td><p><span class="term"><em class="parameter"><code>uid</code></em> :</span></p></td> |
| 278 |
<td>new minimum UID for non-system users. |
| 279 |
</td> |
| 280 |
</tr> |
| 281 |
</tbody> |
| 282 |
</table></div> |
| 283 |
</div> |
| 284 |
<hr> |
| 285 |
<div class="refsect2" title="oobs_users_config_get_maximum_users_uid ()"> |
| 286 |
<a name="oobs-users-config-get-maximum-users-uid"></a><h3>oobs_users_config_get_maximum_users_uid ()</h3> |
| 287 |
<pre class="programlisting"><span class="returnvalue">uid_t</span> oobs_users_config_get_maximum_users_uid |
| 288 |
(<em class="parameter"><code><a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a> *config</code></em>);</pre> |
| 289 |
<p> |
| 290 |
Returns the default maximum UID for non-system users. |
| 291 |
</p> |
| 292 |
<div class="variablelist"><table border="0"> |
| 293 |
<col align="left" valign="top"> |
| 294 |
<tbody> |
| 295 |
<tr> |
| 296 |
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td> |
| 297 |
<td>An <a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a>. |
| 298 |
</td> |
| 299 |
</tr> |
| 300 |
<tr> |
| 301 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 302 |
<td> maximum UID for non-system users. |
| 303 |
</td> |
| 304 |
</tr> |
| 305 |
</tbody> |
| 306 |
</table></div> |
| 307 |
</div> |
| 308 |
<hr> |
| 309 |
<div class="refsect2" title="oobs_users_config_set_maximum_users_uid ()"> |
| 310 |
<a name="oobs-users-config-set-maximum-users-uid"></a><h3>oobs_users_config_set_maximum_users_uid ()</h3> |
| 311 |
<pre class="programlisting"><span class="returnvalue">void</span> oobs_users_config_set_maximum_users_uid |
| 312 |
(<em class="parameter"><code><a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a> *config</code></em>, |
| 313 |
<em class="parameter"><code><span class="type">uid_t</span> uid</code></em>);</pre> |
| 314 |
<p> |
| 315 |
Sets the maximum UID for non-system users. |
| 316 |
</p> |
| 317 |
<div class="variablelist"><table border="0"> |
| 318 |
<col align="left" valign="top"> |
| 319 |
<tbody> |
| 320 |
<tr> |
| 321 |
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td> |
| 322 |
<td>An <a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a>. |
| 323 |
</td> |
| 324 |
</tr> |
| 325 |
<tr> |
| 326 |
<td><p><span class="term"><em class="parameter"><code>uid</code></em> :</span></p></td> |
| 327 |
<td>a new maximum UID for non-system users. |
| 328 |
</td> |
| 329 |
</tr> |
| 330 |
</tbody> |
| 331 |
</table></div> |
| 332 |
</div> |
| 333 |
<hr> |
| 334 |
<div class="refsect2" title="oobs_users_config_get_default_shell ()"> |
| 335 |
<a name="oobs-users-config-get-default-shell"></a><h3>oobs_users_config_get_default_shell ()</h3> |
| 336 |
<pre class="programlisting">const <span class="returnvalue">gchar</span>* oobs_users_config_get_default_shell (<em class="parameter"><code><a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a> *config</code></em>);</pre> |
| 337 |
<p> |
| 338 |
Returns the default shell that will be used for new users. |
| 339 |
</p> |
| 340 |
<div class="variablelist"><table border="0"> |
| 341 |
<col align="left" valign="top"> |
| 342 |
<tbody> |
| 343 |
<tr> |
| 344 |
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td> |
| 345 |
<td>An <a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a> |
| 346 |
</td> |
| 347 |
</tr> |
| 348 |
<tr> |
| 349 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 350 |
<td> A pointer to the default shell as a string. This |
| 351 |
string must not be freed, modified or stored. |
| 352 |
</td> |
| 353 |
</tr> |
| 354 |
</tbody> |
| 355 |
</table></div> |
| 356 |
</div> |
| 357 |
<hr> |
| 358 |
<div class="refsect2" title="oobs_users_config_set_default_shell ()"> |
| 359 |
<a name="oobs-users-config-set-default-shell"></a><h3>oobs_users_config_set_default_shell ()</h3> |
| 360 |
<pre class="programlisting"><span class="returnvalue">void</span> oobs_users_config_set_default_shell (<em class="parameter"><code><a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a> *config</code></em>, |
| 361 |
<em class="parameter"><code>const <span class="type">gchar</span> *shell</code></em>);</pre> |
| 362 |
<p> |
| 363 |
Sets a new default shell for new users, replacing the old one. |
| 364 |
</p> |
| 365 |
<div class="variablelist"><table border="0"> |
| 366 |
<col align="left" valign="top"> |
| 367 |
<tbody> |
| 368 |
<tr> |
| 369 |
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td> |
| 370 |
<td>An <a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a> |
| 371 |
</td> |
| 372 |
</tr> |
| 373 |
<tr> |
| 374 |
<td><p><span class="term"><em class="parameter"><code>shell</code></em> :</span></p></td> |
| 375 |
<td>new default shell for new users. |
| 376 |
</td> |
| 377 |
</tr> |
| 378 |
</tbody> |
| 379 |
</table></div> |
| 380 |
</div> |
| 381 |
<hr> |
| 382 |
<div class="refsect2" title="oobs_users_config_get_default_home_dir ()"> |
| 383 |
<a name="oobs-users-config-get-default-home-dir"></a><h3>oobs_users_config_get_default_home_dir ()</h3> |
| 384 |
<pre class="programlisting">const <span class="returnvalue">gchar</span>* oobs_users_config_get_default_home_dir |
| 385 |
(<em class="parameter"><code><a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a> *config</code></em>);</pre> |
| 386 |
<p> |
| 387 |
Returns the default home directory prefix for new users. when new users |
| 388 |
are created a directory with the user login name is created in that prefix. |
| 389 |
</p> |
| 390 |
<div class="variablelist"><table border="0"> |
| 391 |
<col align="left" valign="top"> |
| 392 |
<tbody> |
| 393 |
<tr> |
| 394 |
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td> |
| 395 |
<td>An <a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a>. |
| 396 |
</td> |
| 397 |
</tr> |
| 398 |
<tr> |
| 399 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 400 |
<td> A pointer to the default home directory prefix as a string. This |
| 401 |
string must not be freed, modified or stored. |
| 402 |
</td> |
| 403 |
</tr> |
| 404 |
</tbody> |
| 405 |
</table></div> |
| 406 |
</div> |
| 407 |
<hr> |
| 408 |
<div class="refsect2" title="oobs_users_config_set_default_home_dir ()"> |
| 409 |
<a name="oobs-users-config-set-default-home-dir"></a><h3>oobs_users_config_set_default_home_dir ()</h3> |
| 410 |
<pre class="programlisting"><span class="returnvalue">void</span> oobs_users_config_set_default_home_dir |
| 411 |
(<em class="parameter"><code><a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a> *config</code></em>, |
| 412 |
<em class="parameter"><code>const <span class="type">gchar</span> *home_dir</code></em>);</pre> |
| 413 |
<p> |
| 414 |
Sets a new home directory prefix used for newly created users, replacing the old one. |
| 415 |
</p> |
| 416 |
<div class="variablelist"><table border="0"> |
| 417 |
<col align="left" valign="top"> |
| 418 |
<tbody> |
| 419 |
<tr> |
| 420 |
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td> |
| 421 |
<td>An <a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a>. |
| 422 |
</td> |
| 423 |
</tr> |
| 424 |
<tr> |
| 425 |
<td><p><span class="term"><em class="parameter"><code>home_dir</code></em> :</span></p></td> |
| 426 |
<td>new default home directory prefix. |
| 427 |
</td> |
| 428 |
</tr> |
| 429 |
</tbody> |
| 430 |
</table></div> |
| 431 |
</div> |
| 432 |
<hr> |
| 433 |
<div class="refsect2" title="oobs_users_config_get_default_group ()"> |
| 434 |
<a name="oobs-users-config-get-default-group"></a><h3>oobs_users_config_get_default_group ()</h3> |
| 435 |
<pre class="programlisting"><a class="link" href="OobsGroup.html" title="OobsGroup"><span class="returnvalue">OobsGroup</span></a>* oobs_users_config_get_default_group (<em class="parameter"><code><a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a> *config</code></em>);</pre> |
| 436 |
<p> |
| 437 |
Returns an <a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a> defining the default group used for new users. |
| 438 |
</p> |
| 439 |
<div class="variablelist"><table border="0"> |
| 440 |
<col align="left" valign="top"> |
| 441 |
<tbody> |
| 442 |
<tr> |
| 443 |
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td> |
| 444 |
<td>An <a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a>. |
| 445 |
</td> |
| 446 |
</tr> |
| 447 |
<tr> |
| 448 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 449 |
<td> An <a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a>, you must not unref this object. |
| 450 |
</td> |
| 451 |
</tr> |
| 452 |
</tbody> |
| 453 |
</table></div> |
| 454 |
</div> |
| 455 |
<hr> |
| 456 |
<div class="refsect2" title="oobs_users_config_get_available_shells ()"> |
| 457 |
<a name="oobs-users-config-get-available-shells"></a><h3>oobs_users_config_get_available_shells ()</h3> |
| 458 |
<pre class="programlisting"><span class="returnvalue">GList</span>* oobs_users_config_get_available_shells |
| 459 |
(<em class="parameter"><code><a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a> *config</code></em>);</pre> |
| 460 |
<p> |
| 461 |
Returns a <span class="type">GList</span> containing strings with paths to the available shells. |
| 462 |
</p> |
| 463 |
<div class="variablelist"><table border="0"> |
| 464 |
<col align="left" valign="top"> |
| 465 |
<tbody> |
| 466 |
<tr> |
| 467 |
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td> |
| 468 |
<td>An <a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a> |
| 469 |
</td> |
| 470 |
</tr> |
| 471 |
<tr> |
| 472 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 473 |
<td> a <span class="type">GList</span> containing strings, you must not free |
| 474 |
neither this list or its elements. |
| 475 |
</td> |
| 476 |
</tr> |
| 477 |
</tbody> |
| 478 |
</table></div> |
| 479 |
</div> |
| 480 |
<hr> |
| 481 |
<div class="refsect2" title="oobs_users_config_get_encrypted_home_support ()"> |
| 482 |
<a name="oobs-users-config-get-encrypted-home-support"></a><h3>oobs_users_config_get_encrypted_home_support ()</h3> |
| 483 |
<pre class="programlisting"><span class="returnvalue">gboolean</span> oobs_users_config_get_encrypted_home_support |
| 484 |
(<em class="parameter"><code><a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a> *config</code></em>);</pre> |
| 485 |
<p> |
| 486 |
Returns whether encrypted home directories are supported by the platform |
| 487 |
(e.g. using eCryptfs). |
| 488 |
</p> |
| 489 |
<div class="variablelist"><table border="0"> |
| 490 |
<col align="left" valign="top"> |
| 491 |
<tbody> |
| 492 |
<tr> |
| 493 |
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td> |
| 494 |
<td>An <a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a> |
| 495 |
</td> |
| 496 |
</tr> |
| 497 |
<tr> |
| 498 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 499 |
<td> <code class="literal">TRUE</code> if encrypted home dirs are supported, <code class="literal">FALSE</code> otherwise. |
| 500 |
</td> |
| 501 |
</tr> |
| 502 |
</tbody> |
| 503 |
</table></div> |
| 504 |
</div> |
| 505 |
<hr> |
| 506 |
<div class="refsect2" title="oobs_users_config_get_available_locales ()"> |
| 507 |
<a name="oobs-users-config-get-available-locales"></a><h3>oobs_users_config_get_available_locales ()</h3> |
| 508 |
<pre class="programlisting"><span class="returnvalue">GList</span>* oobs_users_config_get_available_locales |
| 509 |
(<em class="parameter"><code><a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a> *config</code></em>);</pre> |
| 510 |
<p> |
| 511 |
</p> |
| 512 |
<div class="variablelist"><table border="0"> |
| 513 |
<col align="left" valign="top"> |
| 514 |
<tbody> |
| 515 |
<tr> |
| 516 |
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td> |
| 517 |
<td> |
| 518 |
</td> |
| 519 |
</tr> |
| 520 |
<tr> |
| 521 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 522 |
<td> |
| 523 |
</td> |
| 524 |
</tr> |
| 525 |
</tbody> |
| 526 |
</table></div> |
| 527 |
</div> |
| 528 |
<hr> |
| 529 |
<div class="refsect2" title="oobs_users_config_get_from_login ()"> |
| 530 |
<a name="oobs-users-config-get-from-login"></a><h3>oobs_users_config_get_from_login ()</h3> |
| 531 |
<pre class="programlisting"><a class="link" href="OobsUser.html" title="OobsUser"><span class="returnvalue">OobsUser</span></a>* oobs_users_config_get_from_login (<em class="parameter"><code><a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a> *config</code></em>, |
| 532 |
<em class="parameter"><code>const <span class="type">gchar</span> *login</code></em>);</pre> |
| 533 |
<p> |
| 534 |
Gets the (first) user whose login is <em class="parameter"><code>login</code></em>. This is a convenience function |
| 535 |
to avoid walking manually over the users list. |
| 536 |
</p> |
| 537 |
<div class="variablelist"><table border="0"> |
| 538 |
<col align="left" valign="top"> |
| 539 |
<tbody> |
| 540 |
<tr> |
| 541 |
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td> |
| 542 |
<td>An <a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a>. |
| 543 |
</td> |
| 544 |
</tr> |
| 545 |
<tr> |
| 546 |
<td><p><span class="term"><em class="parameter"><code>login</code></em> :</span></p></td> |
| 547 |
<td>the login name of the wanted user. |
| 548 |
</td> |
| 549 |
</tr> |
| 550 |
<tr> |
| 551 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 552 |
<td> an <a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> corresponding to the passed login, |
| 553 |
or <code class="literal">NULL</code> if no such user exists. Don't forget to unref user when you're done. |
| 554 |
</td> |
| 555 |
</tr> |
| 556 |
</tbody> |
| 557 |
</table></div> |
| 558 |
</div> |
| 559 |
<hr> |
| 560 |
<div class="refsect2" title="oobs_users_config_get_from_uid ()"> |
| 561 |
<a name="oobs-users-config-get-from-uid"></a><h3>oobs_users_config_get_from_uid ()</h3> |
| 562 |
<pre class="programlisting"><a class="link" href="OobsUser.html" title="OobsUser"><span class="returnvalue">OobsUser</span></a>* oobs_users_config_get_from_uid (<em class="parameter"><code><a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a> *config</code></em>, |
| 563 |
<em class="parameter"><code><span class="type">uid_t</span> uid</code></em>);</pre> |
| 564 |
<p> |
| 565 |
Gets the (first) user whose UID is <em class="parameter"><code>uid</code></em>. This is a convenience function |
| 566 |
to avoid walking manually over the users list. |
| 567 |
</p> |
| 568 |
<div class="variablelist"><table border="0"> |
| 569 |
<col align="left" valign="top"> |
| 570 |
<tbody> |
| 571 |
<tr> |
| 572 |
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td> |
| 573 |
<td>An <a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a>. |
| 574 |
</td> |
| 575 |
</tr> |
| 576 |
<tr> |
| 577 |
<td><p><span class="term"><em class="parameter"><code>uid</code></em> :</span></p></td> |
| 578 |
<td>the UID of the wanted user. |
| 579 |
</td> |
| 580 |
</tr> |
| 581 |
<tr> |
| 582 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 583 |
<td> an <a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> corresponding to the passed UID, |
| 584 |
or <code class="literal">NULL</code> if no such user exists. Don't forget to unref user when you're done. |
| 585 |
</td> |
| 586 |
</tr> |
| 587 |
</tbody> |
| 588 |
</table></div> |
| 589 |
</div> |
| 590 |
<hr> |
| 591 |
<div class="refsect2" title="oobs_users_config_is_login_used ()"> |
| 592 |
<a name="oobs-users-config-is-login-used"></a><h3>oobs_users_config_is_login_used ()</h3> |
| 593 |
<pre class="programlisting"><span class="returnvalue">gboolean</span> oobs_users_config_is_login_used (<em class="parameter"><code><a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a> *config</code></em>, |
| 594 |
<em class="parameter"><code>const <span class="type">gchar</span> *login</code></em>);</pre> |
| 595 |
<p> |
| 596 |
Check whether <em class="parameter"><code>login</code></em> is already used by an existing user or not. This is |
| 597 |
a convenience function to avoid walking manually over the users list. |
| 598 |
</p> |
| 599 |
<div class="variablelist"><table border="0"> |
| 600 |
<col align="left" valign="top"> |
| 601 |
<tbody> |
| 602 |
<tr> |
| 603 |
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td> |
| 604 |
<td>An <a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a>. |
| 605 |
</td> |
| 606 |
</tr> |
| 607 |
<tr> |
| 608 |
<td><p><span class="term"><em class="parameter"><code>login</code></em> :</span></p></td> |
| 609 |
<td>the login name to check. |
| 610 |
</td> |
| 611 |
</tr> |
| 612 |
<tr> |
| 613 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 614 |
<td> <code class="literal">TRUE</code> if an user named <em class="parameter"><code>login</code></em> already exists, <code class="literal">FALSE</code> otherwise. |
| 615 |
</td> |
| 616 |
</tr> |
| 617 |
</tbody> |
| 618 |
</table></div> |
| 619 |
</div> |
| 620 |
<hr> |
| 621 |
<div class="refsect2" title="oobs_users_config_is_uid_used ()"> |
| 622 |
<a name="oobs-users-config-is-uid-used"></a><h3>oobs_users_config_is_uid_used ()</h3> |
| 623 |
<pre class="programlisting"><span class="returnvalue">gboolean</span> oobs_users_config_is_uid_used (<em class="parameter"><code><a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a> *config</code></em>, |
| 624 |
<em class="parameter"><code><span class="type">uid_t</span> uid</code></em>);</pre> |
| 625 |
<p> |
| 626 |
Check whether <em class="parameter"><code>uid</code></em> is already used by an existing user or not. This is |
| 627 |
a convenience function to avoid walking manually over the users list. |
| 628 |
</p> |
| 629 |
<div class="variablelist"><table border="0"> |
| 630 |
<col align="left" valign="top"> |
| 631 |
<tbody> |
| 632 |
<tr> |
| 633 |
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td> |
| 634 |
<td>An <a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a>. |
| 635 |
</td> |
| 636 |
</tr> |
| 637 |
<tr> |
| 638 |
<td><p><span class="term"><em class="parameter"><code>uid</code></em> :</span></p></td> |
| 639 |
<td>the UID to check. |
| 640 |
</td> |
| 641 |
</tr> |
| 642 |
<tr> |
| 643 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 644 |
<td> <code class="literal">TRUE</code> if an user with such an UID already exists, <code class="literal">FALSE</code> otherwise. |
| 645 |
</td> |
| 646 |
</tr> |
| 647 |
</tbody> |
| 648 |
</table></div> |
| 649 |
</div> |
| 650 |
<hr> |
| 651 |
<div class="refsect2" title="oobs_users_config_find_free_uid ()"> |
| 652 |
<a name="oobs-users-config-find-free-uid"></a><h3>oobs_users_config_find_free_uid ()</h3> |
| 653 |
<pre class="programlisting"><span class="returnvalue">uid_t</span> oobs_users_config_find_free_uid (<em class="parameter"><code><a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a> *config</code></em>, |
| 654 |
<em class="parameter"><code><span class="type">uid_t</span> uid_min</code></em>, |
| 655 |
<em class="parameter"><code><span class="type">uid_t</span> uid_max</code></em>);</pre> |
| 656 |
<p> |
| 657 |
Finds an UID that is not used by any user in the list. The returned UID is |
| 658 |
the highest used UID in the range plus one if <em class="parameter"><code>uid_max</code></em> is not used. |
| 659 |
Else, the first free UID in the range is returned. |
| 660 |
</p> |
| 661 |
<p> |
| 662 |
If both <em class="parameter"><code>uid_min</code></em> and <em class="parameter"><code>uid_max</code></em> are equal to 0, the default range is used. |
| 663 |
</p> |
| 664 |
<div class="variablelist"><table border="0"> |
| 665 |
<col align="left" valign="top"> |
| 666 |
<tbody> |
| 667 |
<tr> |
| 668 |
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td> |
| 669 |
<td>An <a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a>. |
| 670 |
</td> |
| 671 |
</tr> |
| 672 |
<tr> |
| 673 |
<td><p><span class="term"><em class="parameter"><code>uid_min</code></em> :</span></p></td> |
| 674 |
<td>the minimum wanted UID. |
| 675 |
</td> |
| 676 |
</tr> |
| 677 |
<tr> |
| 678 |
<td><p><span class="term"><em class="parameter"><code>uid_max</code></em> :</span></p></td> |
| 679 |
<td>the maximum wanted UID. |
| 680 |
</td> |
| 681 |
</tr> |
| 682 |
<tr> |
| 683 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 684 |
<td> a free UID in the requested range, |
| 685 |
or <em class="parameter"><code>uid_max</code></em> to indicate wrong use or failure to find a free UID. |
| 686 |
</td> |
| 687 |
</tr> |
| 688 |
</tbody> |
| 689 |
</table></div> |
| 690 |
</div> |
| 691 |
</div> |
| 692 |
<div class="refsect1" title="Property Details"> |
| 693 |
<a name="OobsUsersConfig.property-details"></a><h2>Property Details</h2> |
| 694 |
<div class="refsect2" title='The "default-group" property'> |
| 695 |
<a name="OobsUsersConfig--default-group"></a><h3>The <code class="literal">"default-group"</code> property</h3> |
| 696 |
<pre class="programlisting"> "default-group" <a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a>* : Read</pre> |
| 697 |
<p>Default group for new users.</p> |
| 698 |
</div> |
| 699 |
<hr> |
| 700 |
<div class="refsect2" title='The "default-home" property'> |
| 701 |
<a name="OobsUsersConfig--default-home"></a><h3>The <code class="literal">"default-home"</code> property</h3> |
| 702 |
<pre class="programlisting"> "default-home" <span class="type">gchar</span>* : Read / Write</pre> |
| 703 |
<p>Default home directory for new users.</p> |
| 704 |
<p>Default value: NULL</p> |
| 705 |
</div> |
| 706 |
<hr> |
| 707 |
<div class="refsect2" title='The "default-shell" property'> |
| 708 |
<a name="OobsUsersConfig--default-shell"></a><h3>The <code class="literal">"default-shell"</code> property</h3> |
| 709 |
<pre class="programlisting"> "default-shell" <span class="type">gchar</span>* : Read / Write</pre> |
| 710 |
<p>Default shell for new users.</p> |
| 711 |
<p>Default value: NULL</p> |
| 712 |
</div> |
| 713 |
<hr> |
| 714 |
<div class="refsect2" title='The "encrypted-home" property'> |
| 715 |
<a name="OobsUsersConfig--encrypted-home"></a><h3>The <code class="literal">"encrypted-home"</code> property</h3> |
| 716 |
<pre class="programlisting"> "encrypted-home" <span class="type">gboolean</span> : Read</pre> |
| 717 |
<p>Whether encrypted home dirs are supported.</p> |
| 718 |
<p>Default value: FALSE</p> |
| 719 |
</div> |
| 720 |
<hr> |
| 721 |
<div class="refsect2" title='The "maximum-uid" property'> |
| 722 |
<a name="OobsUsersConfig--maximum-uid"></a><h3>The <code class="literal">"maximum-uid"</code> property</h3> |
| 723 |
<pre class="programlisting"> "maximum-uid" <span class="type">guint</span> : Read / Write</pre> |
| 724 |
<p>Maximum UID for non-system users.</p> |
| 725 |
<p>Allowed values: <= G_MAXINT</p> |
| 726 |
<p>Default value: 2147483647</p> |
| 727 |
</div> |
| 728 |
<hr> |
| 729 |
<div class="refsect2" title='The "minimum-uid" property'> |
| 730 |
<a name="OobsUsersConfig--minimum-uid"></a><h3>The <code class="literal">"minimum-uid"</code> property</h3> |
| 731 |
<pre class="programlisting"> "minimum-uid" <span class="type">guint</span> : Read / Write</pre> |
| 732 |
<p>Minimum UID for non-system users.</p> |
| 733 |
<p>Allowed values: <= G_MAXINT</p> |
| 734 |
<p>Default value: 2147483647</p> |
| 735 |
</div> |
| 736 |
</div> |
| 737 |
<div class="refsect1" title="See Also"> |
| 738 |
<a name="OobsUsersConfig.see-also"></a><h2>See Also</h2> |
| 739 |
<a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> |
| 740 |
</div> |
| 741 |
</div> |
| 742 |
<div class="footer"> |
| 743 |
<hr> |
| 744 |
Generated by GTK-Doc V1.15</div> |
| 745 |
</body> |
| 746 |
</html> |