1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>OobsGroup</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
<link rel="start" href="index.html" title="Liboobs (System configuration management) Reference Manual">
<link rel="up" href="ch03.html" title="Users and groups management">
<link rel="prev" href="OobsUsersConfig.html" title="OobsUsersConfig">
<link rel="next" href="OobsUser.html" title="OobsUser">
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="ch01.html" title="Session management">
<link rel="chapter" href="ch02.html" title="Liboobs data management">
<link rel="chapter" href="ch03.html" title="Users and groups management">
<link rel="chapter" href="ch04.html" title="Shared folders management">
<link rel="chapter" href="ch05.html" title="Date and time management">
<link rel="chapter" href="ch06.html" title="System boot management">
<link rel="chapter" href="ch07.html" title="Network interfaces management">
<link rel="chapter" href="ch08.html" title="Hosts resolution management">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="OobsUsersConfig.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch03.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Liboobs (System configuration management) Reference Manual</th>
<td><a accesskey="n" href="OobsUser.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#OobsGroup.synopsis" class="shortcut">Top</a>
|
<a href="#OobsGroup.description" class="shortcut">Description</a>
|
<a href="#OobsGroup.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#OobsGroup.properties" class="shortcut">Properties</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="OobsGroup"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="OobsGroup.top_of_page"></a>OobsGroup</span></h2>
<p>OobsGroup — Object that represents an individual group.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="OobsGroup.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
<a class="link" href="OobsGroup.html#OobsGroup-struct" title="OobsGroup">OobsGroup</a>;
<a class="link" href="OobsGroup.html" title="OobsGroup">OobsGroup</a>* <a class="link" href="OobsGroup.html#oobs-group-new" title="oobs_group_new ()">oobs_group_new</a> (const gchar *name);
const gchar* <a class="link" href="OobsGroup.html#oobs-group-get-name" title="oobs_group_get_name ()">oobs_group_get_name</a> (<a class="link" href="OobsGroup.html" title="OobsGroup">OobsGroup</a> *group);
void <a class="link" href="OobsGroup.html#oobs-group-set-password" title="oobs_group_set_password ()">oobs_group_set_password</a> (<a class="link" href="OobsGroup.html" title="OobsGroup">OobsGroup</a> *group,
const gchar *password);
void <a class="link" href="OobsGroup.html#oobs-group-set-crypted-password" title="oobs_group_set_crypted_password ()">oobs_group_set_crypted_password</a> (<a class="link" href="OobsGroup.html" title="OobsGroup">OobsGroup</a> *group,
const gchar *crypted_password);
gid_t <a class="link" href="OobsGroup.html#oobs-group-get-gid" title="oobs_group_get_gid ()">oobs_group_get_gid</a> (<a class="link" href="OobsGroup.html" title="OobsGroup">OobsGroup</a> *group);
void <a class="link" href="OobsGroup.html#oobs-group-set-gid" title="oobs_group_set_gid ()">oobs_group_set_gid</a> (<a class="link" href="OobsGroup.html" title="OobsGroup">OobsGroup</a> *group,
gid_t gid);
GList* <a class="link" href="OobsGroup.html#oobs-group-get-users" title="oobs_group_get_users ()">oobs_group_get_users</a> (<a class="link" href="OobsGroup.html" title="OobsGroup">OobsGroup</a> *group);
void <a class="link" href="OobsGroup.html#oobs-group-add-user" title="oobs_group_add_user ()">oobs_group_add_user</a> (<a class="link" href="OobsGroup.html" title="OobsGroup">OobsGroup</a> *group,
<a class="link" href="OobsUser.html" title="OobsUser">OobsUser</a> *user);
void <a class="link" href="OobsGroup.html#oobs-group-remove-user" title="oobs_group_remove_user ()">oobs_group_remove_user</a> (<a class="link" href="OobsGroup.html" title="OobsGroup">OobsGroup</a> *group,
<a class="link" href="OobsUser.html" title="OobsUser">OobsUser</a> *user);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="OobsGroup.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----OobsGroup
</pre>
</div>
<div class="refsect1" lang="en">
<a name="OobsGroup.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="OobsGroup.html#OobsGroup--crypted-password" title='The "crypted-password" property'>crypted-password</a>" gchar* : Read / Write
"<a class="link" href="OobsGroup.html#OobsGroup--gid" title='The "gid" property'>gid</a>" gint : Read / Write
"<a class="link" href="OobsGroup.html#OobsGroup--name" title='The "name" property'>name</a>" gchar* : Read / Write / Construct Only
"<a class="link" href="OobsGroup.html#OobsGroup--password" title='The "password" property'>password</a>" gchar* : Write
</pre>
</div>
<div class="refsect1" lang="en">
<a name="OobsGroup.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1" lang="en">
<a name="OobsGroup.details"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="OobsGroup-struct"></a><h3>OobsGroup</h3>
<pre class="programlisting">typedef struct _OobsGroup OobsGroup;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="oobs-group-new"></a><h3>oobs_group_new ()</h3>
<pre class="programlisting"><a class="link" href="OobsGroup.html" title="OobsGroup">OobsGroup</a>* oobs_group_new (const gchar *name);</pre>
<p>
Returns a newly allocated <a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a> with the name specified by <em class="parameter"><code>name</code></em>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
<td> group name.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A new <a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="oobs-group-get-name"></a><h3>oobs_group_get_name ()</h3>
<pre class="programlisting">const gchar* oobs_group_get_name (<a class="link" href="OobsGroup.html" title="OobsGroup">OobsGroup</a> *group);</pre>
<p>
Returns the name of the group represented by <a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td>
<td> An <a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> A pointer to the group name as a string.
This string must not be freed, modified or stored.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="oobs-group-set-password"></a><h3>oobs_group_set_password ()</h3>
<pre class="programlisting">void oobs_group_set_password (<a class="link" href="OobsGroup.html" title="OobsGroup">OobsGroup</a> *group,
const gchar *password);</pre>
<p>
Sets the group password for the group defined
by <a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a>, overwriting the previous one.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td>
<td> An <a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>password</code></em> :</span></p></td>
<td> A new password for <span class="type">group</span>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="oobs-group-set-crypted-password"></a><h3>oobs_group_set_crypted_password ()</h3>
<pre class="programlisting">void oobs_group_set_crypted_password (<a class="link" href="OobsGroup.html" title="OobsGroup">OobsGroup</a> *group,
const gchar *crypted_password);</pre>
<p>
Sets an already crypted password for the group
defined by <a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a>, overwriting the previous one.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td>
<td> An <a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>crypted_password</code></em> :</span></p></td>
<td> a new crypted password for <span class="type">group</span>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="oobs-group-get-gid"></a><h3>oobs_group_get_gid ()</h3>
<pre class="programlisting">gid_t oobs_group_get_gid (<a class="link" href="OobsGroup.html" title="OobsGroup">OobsGroup</a> *group);</pre>
<p>
Returns the group ID (GID) associated to <a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a></p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td>
<td> An <a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the <span class="type">group</span> GID.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="oobs-group-set-gid"></a><h3>oobs_group_set_gid ()</h3>
<pre class="programlisting">void oobs_group_set_gid (<a class="link" href="OobsGroup.html" title="OobsGroup">OobsGroup</a> *group,
gid_t gid);</pre>
<p>
Sets the group ID (GID) of <span class="type">group</span> to be <span class="type">gid</span>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td>
<td> An <a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>gid</code></em> :</span></p></td>
<td> A new GID for <span class="type">group</span>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="oobs-group-get-users"></a><h3>oobs_group_get_users ()</h3>
<pre class="programlisting">GList* oobs_group_get_users (<a class="link" href="OobsGroup.html" title="OobsGroup">OobsGroup</a> *group);</pre>
<p>
Returns a <span class="type">GList</span> containing pointers to the <a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> objects
that represent the users represented by the group.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td>
<td> An <a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a newly allocated <span class="type">GList</span>, use <code class="function">g_list_free()</code> to free it.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="oobs-group-add-user"></a><h3>oobs_group_add_user ()</h3>
<pre class="programlisting">void oobs_group_add_user (<a class="link" href="OobsGroup.html" title="OobsGroup">OobsGroup</a> *group,
<a class="link" href="OobsUser.html" title="OobsUser">OobsUser</a> *user);</pre>
<p>
Adds a new user to the group. If the user is
already in the group, it does nothing.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td>
<td> An <a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
<td> An <a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> to add to the group.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="oobs-group-remove-user"></a><h3>oobs_group_remove_user ()</h3>
<pre class="programlisting">void oobs_group_remove_user (<a class="link" href="OobsGroup.html" title="OobsGroup">OobsGroup</a> *group,
<a class="link" href="OobsUser.html" title="OobsUser">OobsUser</a> *user);</pre>
<p>
Removes an user from the group. If the user isn't a
member of this group, this function does nothing.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td>
<td> An <a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a>.
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
<td> An <a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> to remove from the group.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="OobsGroup.property-details"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="OobsGroup--crypted-password"></a><h3>The <code class="literal">"crypted-password"</code> property</h3>
<pre class="programlisting"> "crypted-password" gchar* : Read / Write</pre>
<p>Crypted password for the group.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="OobsGroup--gid"></a><h3>The <code class="literal">"gid"</code> property</h3>
<pre class="programlisting"> "gid" gint : Read / Write</pre>
<p>Main group GID for the group.</p>
<p>Allowed values: [0,65534]</p>
<p>Default value: 65534</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="OobsGroup--name"></a><h3>The <code class="literal">"name"</code> property</h3>
<pre class="programlisting"> "name" gchar* : Read / Write / Construct Only</pre>
<p>Name for the group.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="OobsGroup--password"></a><h3>The <code class="literal">"password"</code> property</h3>
<pre class="programlisting"> "password" gchar* : Write</pre>
<p>Password for the group.</p>
<p>Default value: NULL</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.10</div>
</body>
</html>
|
