Debian Codegraph @

doc/reference/html/OobsUser.html

raw
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>OobsUser</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="OobsGroup.html" title="OobsGroup">
10 <link rel="next" href="ch03.html" title="Shared folders management">
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="OobsGroup.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="ch03.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="#OobsUser.synopsis" class="shortcut">Top</a>
25  | 
26 <a href="#OobsUser.description" class="shortcut">Description</a>
27  | 
28 <a href="#OobsUser.object-hierarchy" class="shortcut">Object Hierarchy</a>
29  | 
30 <a href="#OobsUser.properties" class="shortcut">Properties</a>
31 </td></tr>
32 </table>
33 <div class="refentry" title="OobsUser">
34 <a name="OobsUser"></a><div class="titlepage"></div>
35 <div class="refnamediv"><table width="100%"><tr>
36 <td valign="top">
37 <h2><span class="refentrytitle"><a name="OobsUser.top_of_page"></a>OobsUser</span></h2>
38 <p>OobsUser — Object that represents an individual user</p>
39 </td>
40 <td valign="top" align="right"></td>
41 </tr></table></div>
42 <div class="refsynopsisdiv" title="Synopsis">
43 <a name="OobsUser.synopsis"></a><h2>Synopsis</h2>
44 <pre class="synopsis"> <a class="link" href="OobsUser.html#OobsUser-struct" title="OobsUser">OobsUser</a>;
45 <a class="link" href="OobsUser.html#OobsUserClass" title="OobsUserClass">OobsUserClass</a>;
46 enum <a class="link" href="OobsUser.html#OobsUserHomeFlags" title="enum OobsUserHomeFlags">OobsUserHomeFlags</a>;
47 <a class="link" href="OobsUser.html" title="OobsUser"><span class="returnvalue">OobsUser</span></a>* <a class="link" href="OobsUser.html#oobs-user-new" title="oobs_user_new ()">oobs_user_new</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);
48 const <span class="returnvalue">gchar</span>* <a class="link" href="OobsUser.html#oobs-user-get-login-name" title="oobs_user_get_login_name ()">oobs_user_get_login_name</a> (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>);
49 <span class="returnvalue">void</span> <a class="link" href="OobsUser.html#oobs-user-set-password" title="oobs_user_set_password ()">oobs_user_set_password</a> (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>,
50 <em class="parameter"><code>const <span class="type">gchar</span> *password</code></em>);
51 <span class="returnvalue">uid_t</span> <a class="link" href="OobsUser.html#oobs-user-get-uid" title="oobs_user_get_uid ()">oobs_user_get_uid</a> (<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">void</span> <a class="link" href="OobsUser.html#oobs-user-set-uid" title="oobs_user_set_uid ()">oobs_user_set_uid</a> (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>,
53 <em class="parameter"><code><span class="type">uid_t</span> uid</code></em>);
54 <a class="link" href="OobsGroup.html" title="OobsGroup"><span class="returnvalue">OobsGroup</span></a>* <a class="link" href="OobsUser.html#oobs-user-get-main-group" title="oobs_user_get_main_group ()">oobs_user_get_main_group</a> (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>);
55 <span class="returnvalue">void</span> <a class="link" href="OobsUser.html#oobs-user-set-main-group" title="oobs_user_set_main_group ()">oobs_user_set_main_group</a> (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>,
56 <em class="parameter"><code><a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a> *main_group</code></em>);
57 const <span class="returnvalue">gchar</span>* <a class="link" href="OobsUser.html#oobs-user-get-home-directory" title="oobs_user_get_home_directory ()">oobs_user_get_home_directory</a> (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>);
58 <span class="returnvalue">void</span> <a class="link" href="OobsUser.html#oobs-user-set-home-directory" title="oobs_user_set_home_directory ()">oobs_user_set_home_directory</a> (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>,
59 <em class="parameter"><code>const <span class="type">gchar</span> *home_directory</code></em>);
60 const <span class="returnvalue">gchar</span>* <a class="link" href="OobsUser.html#oobs-user-get-shell" title="oobs_user_get_shell ()">oobs_user_get_shell</a> (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>);
61 <span class="returnvalue">void</span> <a class="link" href="OobsUser.html#oobs-user-set-shell" title="oobs_user_set_shell ()">oobs_user_set_shell</a> (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>,
62 <em class="parameter"><code>const <span class="type">gchar</span> *shell</code></em>);
63 const <span class="returnvalue">gchar</span>* <a class="link" href="OobsUser.html#oobs-user-get-full-name" title="oobs_user_get_full_name ()">oobs_user_get_full_name</a> (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>);
64 const <span class="returnvalue">gchar</span>* <a class="link" href="OobsUser.html#oobs-user-get-full-name-fallback" title="oobs_user_get_full_name_fallback ()">oobs_user_get_full_name_fallback</a> (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>);
65 <span class="returnvalue">void</span> <a class="link" href="OobsUser.html#oobs-user-set-full-name" title="oobs_user_set_full_name ()">oobs_user_set_full_name</a> (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>,
66 <em class="parameter"><code>const <span class="type">gchar</span> *full_name</code></em>);
67 const <span class="returnvalue">gchar</span>* <a class="link" href="OobsUser.html#oobs-user-get-room-number" title="oobs_user_get_room_number ()">oobs_user_get_room_number</a> (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>);
68 <span class="returnvalue">void</span> <a class="link" href="OobsUser.html#oobs-user-set-room-number" title="oobs_user_set_room_number ()">oobs_user_set_room_number</a> (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>,
69 <em class="parameter"><code>const <span class="type">gchar</span> *room_number</code></em>);
70 const <span class="returnvalue">gchar</span>* <a class="link" href="OobsUser.html#oobs-user-get-work-phone-number" title="oobs_user_get_work_phone_number ()">oobs_user_get_work_phone_number</a> (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>);
71 <span class="returnvalue">void</span> <a class="link" href="OobsUser.html#oobs-user-set-work-phone-number" title="oobs_user_set_work_phone_number ()">oobs_user_set_work_phone_number</a> (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>,
72 <em class="parameter"><code>const <span class="type">gchar</span> *phone_number</code></em>);
73 const <span class="returnvalue">gchar</span>* <a class="link" href="OobsUser.html#oobs-user-get-home-phone-number" title="oobs_user_get_home_phone_number ()">oobs_user_get_home_phone_number</a> (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>);
74 <span class="returnvalue">void</span> <a class="link" href="OobsUser.html#oobs-user-set-home-phone-number" title="oobs_user_set_home_phone_number ()">oobs_user_set_home_phone_number</a> (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>,
75 <em class="parameter"><code>const <span class="type">gchar</span> *phone_number</code></em>);
76 const <span class="returnvalue">gchar</span>* <a class="link" href="OobsUser.html#oobs-user-get-other-data" title="oobs_user_get_other_data ()">oobs_user_get_other_data</a> (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>);
77 <span class="returnvalue">void</span> <a class="link" href="OobsUser.html#oobs-user-set-other-data" title="oobs_user_set_other_data ()">oobs_user_set_other_data</a> (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>,
78 <em class="parameter"><code>const <span class="type">gchar</span> *data</code></em>);
79 <span class="returnvalue">gboolean</span> <a class="link" href="OobsUser.html#oobs-user-get-password-empty" title="oobs_user_get_password_empty ()">oobs_user_get_password_empty</a> (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>);
80 <span class="returnvalue">void</span> <a class="link" href="OobsUser.html#oobs-user-set-password-empty" title="oobs_user_set_password_empty ()">oobs_user_set_password_empty</a> (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>,
81 <em class="parameter"><code><span class="type">gboolean</span> empty</code></em>);
82 <span class="returnvalue">gboolean</span> <a class="link" href="OobsUser.html#oobs-user-get-password-disabled" title="oobs_user_get_password_disabled ()">oobs_user_get_password_disabled</a> (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>);
83 <span class="returnvalue">void</span> <a class="link" href="OobsUser.html#oobs-user-set-password-disabled" title="oobs_user_set_password_disabled ()">oobs_user_set_password_disabled</a> (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>,
84 <em class="parameter"><code><span class="type">gboolean</span> disabled</code></em>);
85 <span class="returnvalue">gboolean</span> <a class="link" href="OobsUser.html#oobs-user-get-encrypted-home" title="oobs_user_get_encrypted_home ()">oobs_user_get_encrypted_home</a> (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>);
86 <span class="returnvalue">void</span> <a class="link" href="OobsUser.html#oobs-user-set-encrypted-home" title="oobs_user_set_encrypted_home ()">oobs_user_set_encrypted_home</a> (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>,
87 <em class="parameter"><code><span class="type">gboolean</span> encrypted_home</code></em>);
88 <span class="returnvalue">void</span> <a class="link" href="OobsUser.html#oobs-user-set-home-flags" title="oobs_user_set_home_flags ()">oobs_user_set_home_flags</a> (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>,
89 <em class="parameter"><code><a class="link" href="OobsUser.html#OobsUserHomeFlags" title="enum OobsUserHomeFlags"><span class="type">OobsUserHomeFlags</span></a> home_flags</code></em>);
90 const <span class="returnvalue">gchar</span>* <a class="link" href="OobsUser.html#oobs-user-get-locale" title="oobs_user_get_locale ()">oobs_user_get_locale</a> (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>);
91 <span class="returnvalue">void</span> <a class="link" href="OobsUser.html#oobs-user-set-locale" title="oobs_user_set_locale ()">oobs_user_set_locale</a> (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>,
92 <em class="parameter"><code>const <span class="type">gchar</span> *locale</code></em>);
93 <span class="returnvalue">gboolean</span> <a class="link" href="OobsUser.html#oobs-user-get-active" title="oobs_user_get_active ()">oobs_user_get_active</a> (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>);
94 <span class="returnvalue">gboolean</span> <a class="link" href="OobsUser.html#oobs-user-is-root" title="oobs_user_is_root ()">oobs_user_is_root</a> (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>);
95 <span class="returnvalue">gboolean</span> <a class="link" href="OobsUser.html#oobs-user-is-in-group" title="oobs_user_is_in_group ()">oobs_user_is_in_group</a> (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>,
96 <em class="parameter"><code><a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a> *group</code></em>);
97 </pre>
98 </div>
99 <div class="refsect1" title="Object Hierarchy">
100 <a name="OobsUser.object-hierarchy"></a><h2>Object Hierarchy</h2>
101 <pre class="synopsis">
102 GObject
103 +----<a class="link" href="OobsObject.html" title="OobsObject">OobsObject</a>
104 +----OobsUser
105 </pre>
106 </div>
107 <div class="refsect1" title="Properties">
108 <a name="OobsUser.properties"></a><h2>Properties</h2>
109 <pre class="synopsis">
110 "<a class="link" href="OobsUser.html#OobsUser--active" title='The "active" property'>active</a>" <span class="type">gboolean</span> : Read
111 "<a class="link" href="OobsUser.html#OobsUser--encrypted-home" title='The "encrypted-home" property'>encrypted-home</a>" <span class="type">gboolean</span> : Read / Write
112 "<a class="link" href="OobsUser.html#OobsUser--full-name" title='The "full-name" property'>full-name</a>" <span class="type">gchar</span>* : Read / Write
113 "<a class="link" href="OobsUser.html#OobsUser--home-directory" title='The "home-directory" property'>home-directory</a>" <span class="type">gchar</span>* : Read / Write
114 "<a class="link" href="OobsUser.html#OobsUser--home-flags" title='The "home-flags" property'>home-flags</a>" <a class="link" href="OobsUser.html#OobsUserHomeFlags" title="enum OobsUserHomeFlags"><span class="type">OobsUserHomeFlags</span></a> : Read / Write
115 "<a class="link" href="OobsUser.html#OobsUser--home-phone" title='The "home-phone" property'>home-phone</a>" <span class="type">gchar</span>* : Read / Write
116 "<a class="link" href="OobsUser.html#OobsUser--locale" title='The "locale" property'>locale</a>" <span class="type">gchar</span>* : Read / Write
117 "<a class="link" href="OobsUser.html#OobsUser--name" title='The "name" property'>name</a>" <span class="type">gchar</span>* : Read / Write / Construct Only
118 "<a class="link" href="OobsUser.html#OobsUser--other-data" title='The "other-data" property'>other-data</a>" <span class="type">gchar</span>* : Read / Write
119 "<a class="link" href="OobsUser.html#OobsUser--password" title='The "password" property'>password</a>" <span class="type">gchar</span>* : Read / Write
120 "<a class="link" href="OobsUser.html#OobsUser--password-disabled" title='The "password-disabled" property'>password-disabled</a>" <span class="type">gboolean</span> : Read / Write
121 "<a class="link" href="OobsUser.html#OobsUser--password-empty" title='The "password-empty" property'>password-empty</a>" <span class="type">gboolean</span> : Read / Write
122 "<a class="link" href="OobsUser.html#OobsUser--room-number" title='The "room-number" property'>room-number</a>" <span class="type">gchar</span>* : Read / Write
123 "<a class="link" href="OobsUser.html#OobsUser--shell" title='The "shell" property'>shell</a>" <span class="type">gchar</span>* : Read / Write
124 "<a class="link" href="OobsUser.html#OobsUser--uid" title='The "uid" property'>uid</a>" <span class="type">guint</span> : Read / Write
125 "<a class="link" href="OobsUser.html#OobsUser--work-phone" title='The "work-phone" property'>work-phone</a>" <span class="type">gchar</span>* : Read / Write
126 </pre>
127 </div>
128 <div class="refsect1" title="Description">
129 <a name="OobsUser.description"></a><h2>Description</h2>
130 </div>
131 <div class="refsect1" title="Details">
132 <a name="OobsUser.details"></a><h2>Details</h2>
133 <div class="refsect2" title="OobsUser">
134 <a name="OobsUser-struct"></a><h3>OobsUser</h3>
135 <pre class="programlisting">typedef struct _OobsUser OobsUser;</pre>
136 <p>
137 </p>
138 </div>
139 <hr>
140 <div class="refsect2" title="OobsUserClass">
141 <a name="OobsUserClass"></a><h3>OobsUserClass</h3>
142 <pre class="programlisting">typedef struct {
143 OobsObjectClass parent_class;
144
145 void (*_oobs_padding1) (void);
146 void (*_oobs_padding2) (void);
147 void (*_oobs_padding3) (void);
148 void (*_oobs_padding4) (void);
149 } OobsUserClass;
150 </pre>
151 <p>
152 </p>
153 </div>
154 <hr>
155 <div class="refsect2" title="enum OobsUserHomeFlags">
156 <a name="OobsUserHomeFlags"></a><h3>enum OobsUserHomeFlags</h3>
157 <pre class="programlisting">typedef enum {
158 OOBS_USER_REMOVE_HOME = 1,
159 OOBS_USER_CHOWN_HOME = 1 &lt;&lt; 1,
160 OOBS_USER_COPY_HOME = 1 &lt;&lt; 2,
161 OOBS_USER_ERASE_HOME = 1 &lt;&lt; 3
162 } OobsUserHomeFlags;
163 </pre>
164 <p>
165 Determine special behaviors regarding the home directory. Flags only apply to
166 some operations (commit, add or delete user), and have no effect in other cases.
167 </p>
168 <div class="variablelist"><table border="0">
169 <col align="left" valign="top">
170 <tbody>
171 <tr>
172 <td><p><a name="OOBS-USER-REMOVE-HOME:CAPS"></a><span class="term"><code class="literal">OOBS_USER_REMOVE_HOME</code></span></p></td>
173 <td>When removing an <a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a>, also remove home dir; when
174 committing, if home dir changes, remove old home dir.
175 </td>
176 </tr>
177 <tr>
178 <td><p><a name="OOBS-USER-CHOWN-HOME:CAPS"></a><span class="term"><code class="literal">OOBS_USER_CHOWN_HOME</code></span></p></td>
179 <td>When creating or committing an <a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a>, recursively
180 change the owner of home dir to user and main group.
181 </td>
182 </tr>
183 <tr>
184 <td><p><a name="OOBS-USER-COPY-HOME:CAPS"></a><span class="term"><code class="literal">OOBS_USER_COPY_HOME</code></span></p></td>
185 <td>When committing an <a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> and if home dir changes,
186 copy old home to new path, overwriting files if needed (!).
187 </td>
188 </tr>
189 <tr>
190 <td><p><a name="OOBS-USER-ERASE-HOME:CAPS"></a><span class="term"><code class="literal">OOBS_USER_ERASE_HOME</code></span></p></td>
191 <td>When creating an <a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> and a path for home dir is given,
192 or when committing a user and home dir changes, delete already present directory.
193 </td>
194 </tr>
195 </tbody>
196 </table></div>
197 </div>
198 <hr>
199 <div class="refsect2" title="oobs_user_new ()">
200 <a name="oobs-user-new"></a><h3>oobs_user_new ()</h3>
201 <pre class="programlisting"><a class="link" href="OobsUser.html" title="OobsUser"><span class="returnvalue">OobsUser</span></a>* oobs_user_new (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
202 <p>
203 Returns a new user with the given login name.
204 </p>
205 <div class="variablelist"><table border="0">
206 <col align="left" valign="top">
207 <tbody>
208 <tr>
209 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
210 <td>login name for the new user.
211 </td>
212 </tr>
213 <tr>
214 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
215 <td> A newly allocated <a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a>.
216 </td>
217 </tr>
218 </tbody>
219 </table></div>
220 </div>
221 <hr>
222 <div class="refsect2" title="oobs_user_get_login_name ()">
223 <a name="oobs-user-get-login-name"></a><h3>oobs_user_get_login_name ()</h3>
224 <pre class="programlisting">const <span class="returnvalue">gchar</span>* oobs_user_get_login_name (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>);</pre>
225 <p>
226 Returns the login name of the user.
227 </p>
228 <div class="variablelist"><table border="0">
229 <col align="left" valign="top">
230 <tbody>
231 <tr>
232 <td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
233 <td>An <a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a>.
234 </td>
235 </tr>
236 <tr>
237 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
238 <td> A pointer to the login name as a string. This
239 string must not be freed, modified or stored.
240 </td>
241 </tr>
242 </tbody>
243 </table></div>
244 </div>
245 <hr>
246 <div class="refsect2" title="oobs_user_set_password ()">
247 <a name="oobs-user-set-password"></a><h3>oobs_user_set_password ()</h3>
248 <pre class="programlisting"><span class="returnvalue">void</span> oobs_user_set_password (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>,
249 <em class="parameter"><code>const <span class="type">gchar</span> *password</code></em>);</pre>
250 <p>
251 Sets a new password for the user. This password will be
252 interpreted as clean text and encrypted by the backends using PAM.
253 Be careful deleting the passed string after using this function.
254 </p>
255 <div class="variablelist"><table border="0">
256 <col align="left" valign="top">
257 <tbody>
258 <tr>
259 <td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
260 <td>An <a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a>.
261 </td>
262 </tr>
263 <tr>
264 <td><p><span class="term"><em class="parameter"><code>password</code></em> :</span></p></td>
265 <td>a new password for the user.
266 </td>
267 </tr>
268 </tbody>
269 </table></div>
270 </div>
271 <hr>
272 <div class="refsect2" title="oobs_user_get_uid ()">
273 <a name="oobs-user-get-uid"></a><h3>oobs_user_get_uid ()</h3>
274 <pre class="programlisting"><span class="returnvalue">uid_t</span> oobs_user_get_uid (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>);</pre>
275 <p>
276 Returns the UID for this user.
277 </p>
278 <div class="variablelist"><table border="0">
279 <col align="left" valign="top">
280 <tbody>
281 <tr>
282 <td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
283 <td>An <a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a>.
284 </td>
285 </tr>
286 <tr>
287 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
288 <td> user UID.
289 </td>
290 </tr>
291 </tbody>
292 </table></div>
293 </div>
294 <hr>
295 <div class="refsect2" title="oobs_user_set_uid ()">
296 <a name="oobs-user-set-uid"></a><h3>oobs_user_set_uid ()</h3>
297 <pre class="programlisting"><span class="returnvalue">void</span> oobs_user_set_uid (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>,
298 <em class="parameter"><code><span class="type">uid_t</span> uid</code></em>);</pre>
299 <p>
300 Sets a new UID for the user. files formerly owned by the user
301 will not be chowned to the new UID, be careful using this function.
302 </p>
303 <div class="variablelist"><table border="0">
304 <col align="left" valign="top">
305 <tbody>
306 <tr>
307 <td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
308 <td>An <a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a>.
309 </td>
310 </tr>
311 <tr>
312 <td><p><span class="term"><em class="parameter"><code>uid</code></em> :</span></p></td>
313 <td>a new UID for the user.
314 </td>
315 </tr>
316 </tbody>
317 </table></div>
318 </div>
319 <hr>
320 <div class="refsect2" title="oobs_user_get_main_group ()">
321 <a name="oobs-user-get-main-group"></a><h3>oobs_user_get_main_group ()</h3>
322 <pre class="programlisting"><a class="link" href="OobsGroup.html" title="OobsGroup"><span class="returnvalue">OobsGroup</span></a>* oobs_user_get_main_group (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>);</pre>
323 <p>
324 Returns the main group of this user.
325 </p>
326 <div class="variablelist"><table border="0">
327 <col align="left" valign="top">
328 <tbody>
329 <tr>
330 <td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
331 <td>An <a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a>.
332 </td>
333 </tr>
334 <tr>
335 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
336 <td> main group for the user. Release reference when no longer needed.
337 </td>
338 </tr>
339 </tbody>
340 </table></div>
341 </div>
342 <hr>
343 <div class="refsect2" title="oobs_user_set_main_group ()">
344 <a name="oobs-user-set-main-group"></a><h3>oobs_user_set_main_group ()</h3>
345 <pre class="programlisting"><span class="returnvalue">void</span> oobs_user_set_main_group (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>,
346 <em class="parameter"><code><a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a> *main_group</code></em>);</pre>
347 <p>
348 Sets the main group for the user.
349 </p>
350 <div class="variablelist"><table border="0">
351 <col align="left" valign="top">
352 <tbody>
353 <tr>
354 <td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
355 <td>An <a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a>.
356 </td>
357 </tr>
358 <tr>
359 <td><p><span class="term"><em class="parameter"><code>main_group</code></em> :</span></p></td>
360 <td>an <a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a>, new main group for the user.
361 </td>
362 </tr>
363 </tbody>
364 </table></div>
365 </div>
366 <hr>
367 <div class="refsect2" title="oobs_user_get_home_directory ()">
368 <a name="oobs-user-get-home-directory"></a><h3>oobs_user_get_home_directory ()</h3>
369 <pre class="programlisting">const <span class="returnvalue">gchar</span>* oobs_user_get_home_directory (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>);</pre>
370 <p>
371 Returns the home directory path of the user.
372 </p>
373 <div class="variablelist"><table border="0">
374 <col align="left" valign="top">
375 <tbody>
376 <tr>
377 <td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
378 <td>An <a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a>.
379 </td>
380 </tr>
381 <tr>
382 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
383 <td> A pointer to the home directory as a string. This
384 string must not be freed, modified or stored.
385 </td>
386 </tr>
387 </tbody>
388 </table></div>
389 </div>
390 <hr>
391 <div class="refsect2" title="oobs_user_set_home_directory ()">
392 <a name="oobs-user-set-home-directory"></a><h3>oobs_user_set_home_directory ()</h3>
393 <pre class="programlisting"><span class="returnvalue">void</span> oobs_user_set_home_directory (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>,
394 <em class="parameter"><code>const <span class="type">gchar</span> *home_directory</code></em>);</pre>
395 <p>
396 Sets a new home directory for the user. files stored in the previous
397 home directory will not be moved, be careful using this function.
398 </p>
399 <div class="variablelist"><table border="0">
400 <col align="left" valign="top">
401 <tbody>
402 <tr>
403 <td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
404 <td>An <a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a>.
405 </td>
406 </tr>
407 <tr>
408 <td><p><span class="term"><em class="parameter"><code>home_directory</code></em> :</span></p></td>
409 <td>new home directory path for the user.
410 </td>
411 </tr>
412 </tbody>
413 </table></div>
414 </div>
415 <hr>
416 <div class="refsect2" title="oobs_user_get_shell ()">
417 <a name="oobs-user-get-shell"></a><h3>oobs_user_get_shell ()</h3>
418 <pre class="programlisting">const <span class="returnvalue">gchar</span>* oobs_user_get_shell (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>);</pre>
419 <p>
420 Returns the default shell used by the user.
421 </p>
422 <div class="variablelist"><table border="0">
423 <col align="left" valign="top">
424 <tbody>
425 <tr>
426 <td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
427 <td>An <a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a>.
428 </td>
429 </tr>
430 <tr>
431 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
432 <td> A pointer to the default shell as a string. This
433 string must not be freed, modified or stored.
434 </td>
435 </tr>
436 </tbody>
437 </table></div>
438 </div>
439 <hr>
440 <div class="refsect2" title="oobs_user_set_shell ()">
441 <a name="oobs-user-set-shell"></a><h3>oobs_user_set_shell ()</h3>
442 <pre class="programlisting"><span class="returnvalue">void</span> oobs_user_set_shell (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>,
443 <em class="parameter"><code>const <span class="type">gchar</span> *shell</code></em>);</pre>
444 <p>
445 Sets a new default shell for the user.
446 </p>
447 <div class="variablelist"><table border="0">
448 <col align="left" valign="top">
449 <tbody>
450 <tr>
451 <td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
452 <td>An <a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a>.
453 </td>
454 </tr>
455 <tr>
456 <td><p><span class="term"><em class="parameter"><code>shell</code></em> :</span></p></td>
457 <td>a new default shell for the user.
458 </td>
459 </tr>
460 </tbody>
461 </table></div>
462 </div>
463 <hr>
464 <div class="refsect2" title="oobs_user_get_full_name ()">
465 <a name="oobs-user-get-full-name"></a><h3>oobs_user_get_full_name ()</h3>
466 <pre class="programlisting">const <span class="returnvalue">gchar</span>* oobs_user_get_full_name (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>);</pre>
467 <p>
468 Returns the first GECOS field, usually the full name of the user.
469 </p>
470 <div class="variablelist"><table border="0">
471 <col align="left" valign="top">
472 <tbody>
473 <tr>
474 <td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
475 <td>An <a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a>.
476 </td>
477 </tr>
478 <tr>
479 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
480 <td> A pointer to the full name as a string. This
481 string must not be freed, modified or stored.
482 </td>
483 </tr>
484 </tbody>
485 </table></div>
486 </div>
487 <hr>
488 <div class="refsect2" title="oobs_user_get_full_name_fallback ()">
489 <a name="oobs-user-get-full-name-fallback"></a><h3>oobs_user_get_full_name_fallback ()</h3>
490 <pre class="programlisting">const <span class="returnvalue">gchar</span>* oobs_user_get_full_name_fallback (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>);</pre>
491 <p>
492 Returns the first GECOS field, usually the full name of the user,
493 or the login name if the field is empty.
494 </p>
495 <div class="variablelist"><table border="0">
496 <col align="left" valign="top">
497 <tbody>
498 <tr>
499 <td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
500 <td>An <a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a>.
501 </td>
502 </tr>
503 <tr>
504 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
505 <td> A pointer to the full name or login name as a string.
506 This string must not be freed, modified or stored.
507 </td>
508 </tr>
509 </tbody>
510 </table></div>
511 </div>
512 <hr>
513 <div class="refsect2" title="oobs_user_set_full_name ()">
514 <a name="oobs-user-set-full-name"></a><h3>oobs_user_set_full_name ()</h3>
515 <pre class="programlisting"><span class="returnvalue">void</span> oobs_user_set_full_name (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>,
516 <em class="parameter"><code>const <span class="type">gchar</span> *full_name</code></em>);</pre>
517 <p>
518 Sets a new full name for the user.
519 </p>
520 <div class="variablelist"><table border="0">
521 <col align="left" valign="top">
522 <tbody>
523 <tr>
524 <td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
525 <td>An <a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a>.
526 </td>
527 </tr>
528 <tr>
529 <td><p><span class="term"><em class="parameter"><code>full_name</code></em> :</span></p></td>
530 <td>new full name for the user.
531 </td>
532 </tr>
533 </tbody>
534 </table></div>
535 </div>
536 <hr>
537 <div class="refsect2" title="oobs_user_get_room_number ()">
538 <a name="oobs-user-get-room-number"></a><h3>oobs_user_get_room_number ()</h3>
539 <pre class="programlisting">const <span class="returnvalue">gchar</span>* oobs_user_get_room_number (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>);</pre>
540 <p>
541 Returns the second GECOS field, usually the room number.
542 </p>
543 <div class="variablelist"><table border="0">
544 <col align="left" valign="top">
545 <tbody>
546 <tr>
547 <td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
548 <td>An <a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a>.
549 </td>
550 </tr>
551 <tr>
552 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
553 <td> A pointer to the room number as a string. This
554 string must not be freed, modified or stored.
555 </td>
556 </tr>
557 </tbody>
558 </table></div>
559 </div>
560 <hr>
561 <div class="refsect2" title="oobs_user_set_room_number ()">
562 <a name="oobs-user-set-room-number"></a><h3>oobs_user_set_room_number ()</h3>
563 <pre class="programlisting"><span class="returnvalue">void</span> oobs_user_set_room_number (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>,
564 <em class="parameter"><code>const <span class="type">gchar</span> *room_number</code></em>);</pre>
565 <p>
566 Sets a new room number for the user.
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>user</code></em> :</span></p></td>
573 <td>An <a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a>.
574 </td>
575 </tr>
576 <tr>
577 <td><p><span class="term"><em class="parameter"><code>room_number</code></em> :</span></p></td>
578 <td>new room number for the user.
579 </td>
580 </tr>
581 </tbody>
582 </table></div>
583 </div>
584 <hr>
585 <div class="refsect2" title="oobs_user_get_work_phone_number ()">
586 <a name="oobs-user-get-work-phone-number"></a><h3>oobs_user_get_work_phone_number ()</h3>
587 <pre class="programlisting">const <span class="returnvalue">gchar</span>* oobs_user_get_work_phone_number (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>);</pre>
588 <p>
589 Returns the third GECOS field, usually the work phone number.
590 </p>
591 <div class="variablelist"><table border="0">
592 <col align="left" valign="top">
593 <tbody>
594 <tr>
595 <td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
596 <td>An <a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a>.
597 </td>
598 </tr>
599 <tr>
600 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
601 <td> A pointer to the work phone number as a string. This
602 string must not be freed, modified or stored.
603 </td>
604 </tr>
605 </tbody>
606 </table></div>
607 </div>
608 <hr>
609 <div class="refsect2" title="oobs_user_set_work_phone_number ()">
610 <a name="oobs-user-set-work-phone-number"></a><h3>oobs_user_set_work_phone_number ()</h3>
611 <pre class="programlisting"><span class="returnvalue">void</span> oobs_user_set_work_phone_number (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>,
612 <em class="parameter"><code>const <span class="type">gchar</span> *phone_number</code></em>);</pre>
613 <p>
614 Sets a new work phone number for the user.
615 </p>
616 <div class="variablelist"><table border="0">
617 <col align="left" valign="top">
618 <tbody>
619 <tr>
620 <td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
621 <td>An <a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a>.
622 </td>
623 </tr>
624 <tr>
625 <td><p><span class="term"><em class="parameter"><code>phone_number</code></em> :</span></p></td>
626 <td>new work phone number for the user.
627 </td>
628 </tr>
629 </tbody>
630 </table></div>
631 </div>
632 <hr>
633 <div class="refsect2" title="oobs_user_get_home_phone_number ()">
634 <a name="oobs-user-get-home-phone-number"></a><h3>oobs_user_get_home_phone_number ()</h3>
635 <pre class="programlisting">const <span class="returnvalue">gchar</span>* oobs_user_get_home_phone_number (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>);</pre>
636 <p>
637 Returns the fourth GECOS field, usually the home phone number.
638 </p>
639 <div class="variablelist"><table border="0">
640 <col align="left" valign="top">
641 <tbody>
642 <tr>
643 <td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
644 <td>An <a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a>.
645 </td>
646 </tr>
647 <tr>
648 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
649 <td> A pointer to the home phone number as a string. This
650 string must not be freed, modified or stored.
651 </td>
652 </tr>
653 </tbody>
654 </table></div>
655 </div>
656 <hr>
657 <div class="refsect2" title="oobs_user_set_home_phone_number ()">
658 <a name="oobs-user-set-home-phone-number"></a><h3>oobs_user_set_home_phone_number ()</h3>
659 <pre class="programlisting"><span class="returnvalue">void</span> oobs_user_set_home_phone_number (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>,
660 <em class="parameter"><code>const <span class="type">gchar</span> *phone_number</code></em>);</pre>
661 <p>
662 Sets a new home phone number for the user.
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>user</code></em> :</span></p></td>
669 <td>An <a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a>.
670 </td>
671 </tr>
672 <tr>
673 <td><p><span class="term"><em class="parameter"><code>phone_number</code></em> :</span></p></td>
674 <td>new home phone number for the user.
675 </td>
676 </tr>
677 </tbody>
678 </table></div>
679 </div>
680 <hr>
681 <div class="refsect2" title="oobs_user_get_other_data ()">
682 <a name="oobs-user-get-other-data"></a><h3>oobs_user_get_other_data ()</h3>
683 <pre class="programlisting">const <span class="returnvalue">gchar</span>* oobs_user_get_other_data (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>);</pre>
684 <p>
685 Returns the fifth field of GECOS fields, reserved for additional data.
686 </p>
687 <div class="variablelist"><table border="0">
688 <col align="left" valign="top">
689 <tbody>
690 <tr>
691 <td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
692 <td>An <a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a>.
693 </td>
694 </tr>
695 <tr>
696 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
697 <td> A pointer to the fifth GECOS field as a string. This
698 string must not be freed, modified or stored.
699 </td>
700 </tr>
701 </tbody>
702 </table></div>
703 </div>
704 <hr>
705 <div class="refsect2" title="oobs_user_set_other_data ()">
706 <a name="oobs-user-set-other-data"></a><h3>oobs_user_set_other_data ()</h3>
707 <pre class="programlisting"><span class="returnvalue">void</span> oobs_user_set_other_data (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>,
708 <em class="parameter"><code>const <span class="type">gchar</span> *data</code></em>);</pre>
709 <p>
710 Sets the data in the fifth GECOS field.
711 </p>
712 <div class="variablelist"><table border="0">
713 <col align="left" valign="top">
714 <tbody>
715 <tr>
716 <td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
717 <td>An <a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a>.
718 </td>
719 </tr>
720 <tr>
721 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
722 <td>data in the fifth GECOS field.
723 </td>
724 </tr>
725 </tbody>
726 </table></div>
727 </div>
728 <hr>
729 <div class="refsect2" title="oobs_user_get_password_empty ()">
730 <a name="oobs-user-get-password-empty"></a><h3>oobs_user_get_password_empty ()</h3>
731 <pre class="programlisting"><span class="returnvalue">gboolean</span> oobs_user_get_password_empty (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>);</pre>
732 <p>
733 Returns whether the current password for <em class="parameter"><code>user</code></em> is empty.
734 </p>
735 <div class="variablelist"><table border="0">
736 <col align="left" valign="top">
737 <tbody>
738 <tr>
739 <td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
740 <td>An <a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a>.
741 </td>
742 </tr>
743 <tr>
744 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
745 <td> <code class="literal">TRUE</code> if <em class="parameter"><code>user</code></em> is using an empty password, <code class="literal">FALSE</code> otherwise.
746 </td>
747 </tr>
748 </tbody>
749 </table></div>
750 </div>
751 <hr>
752 <div class="refsect2" title="oobs_user_set_password_empty ()">
753 <a name="oobs-user-set-password-empty"></a><h3>oobs_user_set_password_empty ()</h3>
754 <pre class="programlisting"><span class="returnvalue">void</span> oobs_user_set_password_empty (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>,
755 <em class="parameter"><code><span class="type">gboolean</span> empty</code></em>);</pre>
756 <p>
757 Forces an empty password for <em class="parameter"><code>user</code></em>. (Setting the 'password' property
758 to the empty string is used to keep the current password.)
759 </p>
760 <div class="variablelist"><table border="0">
761 <col align="left" valign="top">
762 <tbody>
763 <tr>
764 <td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
765 <td>An <a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a>.
766 </td>
767 </tr>
768 <tr>
769 <td><p><span class="term"><em class="parameter"><code>empty</code></em> :</span></p></td>
770 <td>whether password for <em class="parameter"><code>user</code></em> should be set to empty.
771 </td>
772 </tr>
773 </tbody>
774 </table></div>
775 </div>
776 <hr>
777 <div class="refsect2" title="oobs_user_get_password_disabled ()">
778 <a name="oobs-user-get-password-disabled"></a><h3>oobs_user_get_password_disabled ()</h3>
779 <pre class="programlisting"><span class="returnvalue">gboolean</span> oobs_user_get_password_disabled (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>);</pre>
780 <p>
781 Returns whether account for <em class="parameter"><code>user</code></em> is currently disabled,
782 i.e. user is not allowed to log in.
783 </p>
784 <div class="variablelist"><table border="0">
785 <col align="left" valign="top">
786 <tbody>
787 <tr>
788 <td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
789 <td>An <a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a>.
790 </td>
791 </tr>
792 <tr>
793 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
794 <td> <code class="literal">TRUE</code> if account is disabled, <code class="literal">FALSE</code> otherwise.
795 </td>
796 </tr>
797 </tbody>
798 </table></div>
799 </div>
800 <hr>
801 <div class="refsect2" title="oobs_user_set_password_disabled ()">
802 <a name="oobs-user-set-password-disabled"></a><h3>oobs_user_set_password_disabled ()</h3>
803 <pre class="programlisting"><span class="returnvalue">void</span> oobs_user_set_password_disabled (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>,
804 <em class="parameter"><code><span class="type">gboolean</span> disabled</code></em>);</pre>
805 <p>
806 Disable or enable account, allowing or preventing <em class="parameter"><code>user</code></em> from logging in.
807 </p>
808 <div class="variablelist"><table border="0">
809 <col align="left" valign="top">
810 <tbody>
811 <tr>
812 <td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
813 <td>An <a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a>.
814 </td>
815 </tr>
816 <tr>
817 <td><p><span class="term"><em class="parameter"><code>disabled</code></em> :</span></p></td>
818 <td>whether account for <em class="parameter"><code>user</code></em> should be disabled.
819 </td>
820 </tr>
821 </tbody>
822 </table></div>
823 </div>
824 <hr>
825 <div class="refsect2" title="oobs_user_get_encrypted_home ()">
826 <a name="oobs-user-get-encrypted-home"></a><h3>oobs_user_get_encrypted_home ()</h3>
827 <pre class="programlisting"><span class="returnvalue">gboolean</span> oobs_user_get_encrypted_home (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>);</pre>
828 <p>
829 Returns whether home directory for <em class="parameter"><code>user</code></em> is encrypted (e.g. using eCryptfs).
830 </p>
831 <div class="variablelist"><table border="0">
832 <col align="left" valign="top">
833 <tbody>
834 <tr>
835 <td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
836 <td>An <a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a>.
837 </td>
838 </tr>
839 <tr>
840 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
841 <td> <code class="literal">TRUE</code> if home is encrypted, <code class="literal">FALSE</code> otherwise.
842 </td>
843 </tr>
844 </tbody>
845 </table></div>
846 </div>
847 <hr>
848 <div class="refsect2" title="oobs_user_set_encrypted_home ()">
849 <a name="oobs-user-set-encrypted-home"></a><h3>oobs_user_set_encrypted_home ()</h3>
850 <pre class="programlisting"><span class="returnvalue">void</span> oobs_user_set_encrypted_home (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>,
851 <em class="parameter"><code><span class="type">gboolean</span> encrypted_home</code></em>);</pre>
852 <p>
853 Set whether home directory for <em class="parameter"><code>user</code></em> should be encrypted.
854 This function should only be used on new users before committing them,
855 and when the system supports it for the change to take effect.
856 </p>
857 <div class="variablelist"><table border="0">
858 <col align="left" valign="top">
859 <tbody>
860 <tr>
861 <td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
862 <td>An <a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a>.
863 </td>
864 </tr>
865 <tr>
866 <td><p><span class="term"><em class="parameter"><code>encrypted_home</code></em> :</span></p></td>
867 <td>whether home directory for <em class="parameter"><code>user</code></em> should be encrypted.
868 </td>
869 </tr>
870 </tbody>
871 </table></div>
872 </div>
873 <hr>
874 <div class="refsect2" title="oobs_user_set_home_flags ()">
875 <a name="oobs-user-set-home-flags"></a><h3>oobs_user_set_home_flags ()</h3>
876 <pre class="programlisting"><span class="returnvalue">void</span> oobs_user_set_home_flags (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>,
877 <em class="parameter"><code><a class="link" href="OobsUser.html#OobsUserHomeFlags" title="enum OobsUserHomeFlags"><span class="type">OobsUserHomeFlags</span></a> home_flags</code></em>);</pre>
878 <p>
879 Set the flags affecting treatment of the user's home directory (remove home
880 when deleting user, chown directory to user...).
881 </p>
882 <div class="variablelist"><table border="0">
883 <col align="left" valign="top">
884 <tbody>
885 <tr>
886 <td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
887 <td>An <a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a>.
888 </td>
889 </tr>
890 <tr>
891 <td><p><span class="term"><em class="parameter"><code>home_flags</code></em> :</span></p></td>
892 <td>how home directory for <em class="parameter"><code>user</code></em> should be treated.
893 </td>
894 </tr>
895 </tbody>
896 </table></div>
897 </div>
898 <hr>
899 <div class="refsect2" title="oobs_user_get_locale ()">
900 <a name="oobs-user-get-locale"></a><h3>oobs_user_get_locale ()</h3>
901 <pre class="programlisting">const <span class="returnvalue">gchar</span>* oobs_user_get_locale (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>);</pre>
902 <p>
903 </p>
904 <div class="variablelist"><table border="0">
905 <col align="left" valign="top">
906 <tbody>
907 <tr>
908 <td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
909 <td>
910 </td>
911 </tr>
912 <tr>
913 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
914 <td>
915 </td>
916 </tr>
917 </tbody>
918 </table></div>
919 </div>
920 <hr>
921 <div class="refsect2" title="oobs_user_set_locale ()">
922 <a name="oobs-user-set-locale"></a><h3>oobs_user_set_locale ()</h3>
923 <pre class="programlisting"><span class="returnvalue">void</span> oobs_user_set_locale (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>,
924 <em class="parameter"><code>const <span class="type">gchar</span> *locale</code></em>);</pre>
925 <p>
926 Sets the ISO 639 code representing the current locale for <em class="parameter"><code>user</code></em>.
927 </p>
928 <div class="variablelist"><table border="0">
929 <col align="left" valign="top">
930 <tbody>
931 <tr>
932 <td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
933 <td>An <a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a>.
934 </td>
935 </tr>
936 <tr>
937 <td><p><span class="term"><em class="parameter"><code>locale</code></em> :</span></p></td>
938 <td>Preferred locale for <em class="parameter"><code>user</code></em>.
939 </td>
940 </tr>
941 </tbody>
942 </table></div>
943 </div>
944 <hr>
945 <div class="refsect2" title="oobs_user_get_active ()">
946 <a name="oobs-user-get-active"></a><h3>oobs_user_get_active ()</h3>
947 <pre class="programlisting"><span class="returnvalue">gboolean</span> oobs_user_get_active (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>);</pre>
948 <p>
949 Returns whether the use is currently logged in the system.
950 </p>
951 <div class="variablelist"><table border="0">
952 <col align="left" valign="top">
953 <tbody>
954 <tr>
955 <td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
956 <td>An <a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a>
957 </td>
958 </tr>
959 <tr>
960 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
961 <td> <span class="type">TRUE</span> if the user is logged in the system.
962 </td>
963 </tr>
964 </tbody>
965 </table></div>
966 </div>
967 <hr>
968 <div class="refsect2" title="oobs_user_is_root ()">
969 <a name="oobs-user-is-root"></a><h3>oobs_user_is_root ()</h3>
970 <pre class="programlisting"><span class="returnvalue">gboolean</span> oobs_user_is_root (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>);</pre>
971 <p>
972 Checks whether a group is the superuser, according to its name.
973 </p>
974 <div class="variablelist"><table border="0">
975 <col align="left" valign="top">
976 <tbody>
977 <tr>
978 <td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
979 <td>An <a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a>.
980 </td>
981 </tr>
982 <tr>
983 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
984 <td> <code class="literal">TRUE</code> if <em class="parameter"><code>user</code></em> is the root user, <code class="literal">FALSE</code> otherwise.
985 </td>
986 </tr>
987 </tbody>
988 </table></div>
989 </div>
990 <hr>
991 <div class="refsect2" title="oobs_user_is_in_group ()">
992 <a name="oobs-user-is-in-group"></a><h3>oobs_user_is_in_group ()</h3>
993 <pre class="programlisting"><span class="returnvalue">gboolean</span> oobs_user_is_in_group (<em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>,
994 <em class="parameter"><code><a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a> *group</code></em>);</pre>
995 <p>
996 Checks whether a user member of <em class="parameter"><code>group</code></em>.
997 </p>
998 <div class="variablelist"><table border="0">
999 <col align="left" valign="top">
1000 <tbody>
1001 <tr>
1002 <td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
1003 <td>An <a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a>.
1004 </td>
1005 </tr>
1006 <tr>
1007 <td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td>
1008 <td>An <a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a>.
1009 </td>
1010 </tr>
1011 <tr>
1012 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1013 <td> <code class="literal">TRUE</code> if <em class="parameter"><code>user</code></em> is in <em class="parameter"><code>group</code></em>, <code class="literal">FALSE</code> otherwise.
1014 </td>
1015 </tr>
1016 </tbody>
1017 </table></div>
1018 </div>
1019 </div>
1020 <div class="refsect1" title="Property Details">
1021 <a name="OobsUser.property-details"></a><h2>Property Details</h2>
1022 <div class="refsect2" title='The "active" property'>
1023 <a name="OobsUser--active"></a><h3>The <code class="literal">"active"</code> property</h3>
1024 <pre class="programlisting"> "active" <span class="type">gboolean</span> : Read</pre>
1025 <p>Whether the user is active.</p>
1026 <p>Default value: FALSE</p>
1027 </div>
1028 <hr>
1029 <div class="refsect2" title='The "encrypted-home" property'>
1030 <a name="OobsUser--encrypted-home"></a><h3>The <code class="literal">"encrypted-home"</code> property</h3>
1031 <pre class="programlisting"> "encrypted-home" <span class="type">gboolean</span> : Read / Write</pre>
1032 <p>Whether user's home is encrypted.</p>
1033 <p>Default value: FALSE</p>
1034 </div>
1035 <hr>
1036 <div class="refsect2" title='The "full-name" property'>
1037 <a name="OobsUser--full-name"></a><h3>The <code class="literal">"full-name"</code> property</h3>
1038 <pre class="programlisting"> "full-name" <span class="type">gchar</span>* : Read / Write</pre>
1039 <p>User's full name.</p>
1040 <p>Default value: NULL</p>
1041 </div>
1042 <hr>
1043 <div class="refsect2" title='The "home-directory" property'>
1044 <a name="OobsUser--home-directory"></a><h3>The <code class="literal">"home-directory"</code> property</h3>
1045 <pre class="programlisting"> "home-directory" <span class="type">gchar</span>* : Read / Write</pre>
1046 <p>Home directory for the user.</p>
1047 <p>Default value: NULL</p>
1048 </div>
1049 <hr>
1050 <div class="refsect2" title='The "home-flags" property'>
1051 <a name="OobsUser--home-flags"></a><h3>The <code class="literal">"home-flags"</code> property</h3>
1052 <pre class="programlisting"> "home-flags" <a class="link" href="OobsUser.html#OobsUserHomeFlags" title="enum OobsUserHomeFlags"><span class="type">OobsUserHomeFlags</span></a> : Read / Write</pre>
1053 <p>Flags affecting home directory treatment.</p>
1054 </div>
1055 <hr>
1056 <div class="refsect2" title='The "home-phone" property'>
1057 <a name="OobsUser--home-phone"></a><h3>The <code class="literal">"home-phone"</code> property</h3>
1058 <pre class="programlisting"> "home-phone" <span class="type">gchar</span>* : Read / Write</pre>
1059 <p>User's home phone.</p>
1060 <p>Default value: NULL</p>
1061 </div>
1062 <hr>
1063 <div class="refsect2" title='The "locale" property'>
1064 <a name="OobsUser--locale"></a><h3>The <code class="literal">"locale"</code> property</h3>
1065 <pre class="programlisting"> "locale" <span class="type">gchar</span>* : Read / Write</pre>
1066 <p>Preferred locale for the user.</p>
1067 <p>Default value: NULL</p>
1068 </div>
1069 <hr>
1070 <div class="refsect2" title='The "name" property'>
1071 <a name="OobsUser--name"></a><h3>The <code class="literal">"name"</code> property</h3>
1072 <pre class="programlisting"> "name" <span class="type">gchar</span>* : Read / Write / Construct Only</pre>
1073 <p>Login name for the user.</p>
1074 <p>Default value: NULL</p>
1075 </div>
1076 <hr>
1077 <div class="refsect2" title='The "other-data" property'>
1078 <a name="OobsUser--other-data"></a><h3>The <code class="literal">"other-data"</code> property</h3>
1079 <pre class="programlisting"> "other-data" <span class="type">gchar</span>* : Read / Write</pre>
1080 <p>Aditional data for the user.</p>
1081 <p>Default value: NULL</p>
1082 </div>
1083 <hr>
1084 <div class="refsect2" title='The "password" property'>
1085 <a name="OobsUser--password"></a><h3>The <code class="literal">"password"</code> property</h3>
1086 <pre class="programlisting"> "password" <span class="type">gchar</span>* : Read / Write</pre>
1087 <p>Password for the user.</p>
1088 <p>Default value: NULL</p>
1089 </div>
1090 <hr>
1091 <div class="refsect2" title='The "password-disabled" property'>
1092 <a name="OobsUser--password-disabled"></a><h3>The <code class="literal">"password-disabled"</code> property</h3>
1093 <pre class="programlisting"> "password-disabled" <span class="type">gboolean</span> : Read / Write</pre>
1094 <p>Whether user is forbidden logging in.</p>
1095 <p>Default value: FALSE</p>
1096 </div>
1097 <hr>
1098 <div class="refsect2" title='The "password-empty" property'>
1099 <a name="OobsUser--password-empty"></a><h3>The <code class="literal">"password-empty"</code> property</h3>
1100 <pre class="programlisting"> "password-empty" <span class="type">gboolean</span> : Read / Write</pre>
1101 <p>Whether user password is empty.</p>
1102 <p>Default value: FALSE</p>
1103 </div>
1104 <hr>
1105 <div class="refsect2" title='The "room-number" property'>
1106 <a name="OobsUser--room-number"></a><h3>The <code class="literal">"room-number"</code> property</h3>
1107 <pre class="programlisting"> "room-number" <span class="type">gchar</span>* : Read / Write</pre>
1108 <p>User's room number.</p>
1109 <p>Default value: NULL</p>
1110 </div>
1111 <hr>
1112 <div class="refsect2" title='The "shell" property'>
1113 <a name="OobsUser--shell"></a><h3>The <code class="literal">"shell"</code> property</h3>
1114 <pre class="programlisting"> "shell" <span class="type">gchar</span>* : Read / Write</pre>
1115 <p>Default shell for the user.</p>
1116 <p>Default value: NULL</p>
1117 </div>
1118 <hr>
1119 <div class="refsect2" title='The "uid" property'>
1120 <a name="OobsUser--uid"></a><h3>The <code class="literal">"uid"</code> property</h3>
1121 <pre class="programlisting"> "uid" <span class="type">guint</span> : Read / Write</pre>
1122 <p>UID for the user.</p>
1123 <p>Allowed values: &lt;= G_MAXINT</p>
1124 <p>Default value: 2147483647</p>
1125 </div>
1126 <hr>
1127 <div class="refsect2" title='The "work-phone" property'>
1128 <a name="OobsUser--work-phone"></a><h3>The <code class="literal">"work-phone"</code> property</h3>
1129 <pre class="programlisting"> "work-phone" <span class="type">gchar</span>* : Read / Write</pre>
1130 <p>User's work phone.</p>
1131 <p>Default value: NULL</p>
1132 </div>
1133 </div>
1134 <div class="refsect1" title="See Also">
1135 <a name="OobsUser.see-also"></a><h2>See Also</h2>
1136 <a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig"><span class="type">OobsUsersConfig</span></a>
1137 </div>
1138 </div>
1139 <div class="footer">
1140 <hr>
1141 Generated by GTK-Doc V1.15</div>
1142 </body>
1143 </html>