Debian Codegraph @

doc/reference/html/OobsGroup.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>OobsGroup</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="OobsSelfConfig.html" title="OobsSelfConfig">
10 <link rel="next" href="OobsUser.html" title="OobsUser">
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="OobsSelfConfig.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="OobsUser.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="#OobsGroup.synopsis" class="shortcut">Top</a>
25  | 
26 <a href="#OobsGroup.description" class="shortcut">Description</a>
27  | 
28 <a href="#OobsGroup.object-hierarchy" class="shortcut">Object Hierarchy</a>
29  | 
30 <a href="#OobsGroup.properties" class="shortcut">Properties</a>
31 </td></tr>
32 </table>
33 <div class="refentry" title="OobsGroup">
34 <a name="OobsGroup"></a><div class="titlepage"></div>
35 <div class="refnamediv"><table width="100%"><tr>
36 <td valign="top">
37 <h2><span class="refentrytitle"><a name="OobsGroup.top_of_page"></a>OobsGroup</span></h2>
38 <p>OobsGroup — Object that represents an individual group</p>
39 </td>
40 <td valign="top" align="right"></td>
41 </tr></table></div>
42 <div class="refsynopsisdiv" title="Synopsis">
43 <a name="OobsGroup.synopsis"></a><h2>Synopsis</h2>
44 <pre class="synopsis"> <a class="link" href="OobsGroup.html#OobsGroup-struct" title="OobsGroup">OobsGroup</a>;
45 <a class="link" href="OobsGroup.html#OobsGroupClass" title="OobsGroupClass">OobsGroupClass</a>;
46 <a class="link" href="OobsGroup.html" title="OobsGroup"><span class="returnvalue">OobsGroup</span></a>* <a class="link" href="OobsGroup.html#oobs-group-new" title="oobs_group_new ()">oobs_group_new</a> (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);
47 const <span class="returnvalue">gchar</span>* <a class="link" href="OobsGroup.html#oobs-group-get-name" title="oobs_group_get_name ()">oobs_group_get_name</a> (<em class="parameter"><code><a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a> *group</code></em>);
48 <span class="returnvalue">void</span> <a class="link" href="OobsGroup.html#oobs-group-set-password" title="oobs_group_set_password ()">oobs_group_set_password</a> (<em class="parameter"><code><a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a> *group</code></em>,
49 <em class="parameter"><code>const <span class="type">gchar</span> *password</code></em>);
50 <span class="returnvalue">gid_t</span> <a class="link" href="OobsGroup.html#oobs-group-get-gid" title="oobs_group_get_gid ()">oobs_group_get_gid</a> (<em class="parameter"><code><a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a> *group</code></em>);
51 <span class="returnvalue">void</span> <a class="link" href="OobsGroup.html#oobs-group-set-gid" title="oobs_group_set_gid ()">oobs_group_set_gid</a> (<em class="parameter"><code><a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a> *group</code></em>,
52 <em class="parameter"><code><span class="type">gid_t</span> gid</code></em>);
53 <span class="returnvalue">GList</span> * <a class="link" href="OobsGroup.html#oobs-group-get-users" title="oobs_group_get_users ()">oobs_group_get_users</a> (<em class="parameter"><code><a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a> *group</code></em>);
54 <span class="returnvalue">void</span> <a class="link" href="OobsGroup.html#oobs-group-clear-users" title="oobs_group_clear_users ()">oobs_group_clear_users</a> (<em class="parameter"><code><a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a> *group</code></em>);
55 <span class="returnvalue">void</span> <a class="link" href="OobsGroup.html#oobs-group-add-user" title="oobs_group_add_user ()">oobs_group_add_user</a> (<em class="parameter"><code><a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a> *group</code></em>,
56 <em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>);
57 <span class="returnvalue">void</span> <a class="link" href="OobsGroup.html#oobs-group-remove-user" title="oobs_group_remove_user ()">oobs_group_remove_user</a> (<em class="parameter"><code><a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a> *group</code></em>,
58 <em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>);
59 <span class="returnvalue">gboolean</span> <a class="link" href="OobsGroup.html#oobs-group-is-root" title="oobs_group_is_root ()">oobs_group_is_root</a> (<em class="parameter"><code><a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a> *group</code></em>);
60 </pre>
61 </div>
62 <div class="refsect1" title="Object Hierarchy">
63 <a name="OobsGroup.object-hierarchy"></a><h2>Object Hierarchy</h2>
64 <pre class="synopsis">
65 GObject
66 +----<a class="link" href="OobsObject.html" title="OobsObject">OobsObject</a>
67 +----OobsGroup
68 </pre>
69 </div>
70 <div class="refsect1" title="Properties">
71 <a name="OobsGroup.properties"></a><h2>Properties</h2>
72 <pre class="synopsis">
73 "<a class="link" href="OobsGroup.html#OobsGroup--gid" title='The "gid" property'>gid</a>" <span class="type">guint</span> : Read / Write
74 "<a class="link" href="OobsGroup.html#OobsGroup--name" title='The "name" property'>name</a>" <span class="type">gchar</span>* : Read / Write / Construct Only
75 "<a class="link" href="OobsGroup.html#OobsGroup--password" title='The "password" property'>password</a>" <span class="type">gchar</span>* : Read / Write
76 </pre>
77 </div>
78 <div class="refsect1" title="Description">
79 <a name="OobsGroup.description"></a><h2>Description</h2>
80 </div>
81 <div class="refsect1" title="Details">
82 <a name="OobsGroup.details"></a><h2>Details</h2>
83 <div class="refsect2" title="OobsGroup">
84 <a name="OobsGroup-struct"></a><h3>OobsGroup</h3>
85 <pre class="programlisting">typedef struct _OobsGroup OobsGroup;</pre>
86 <p>
87 </p>
88 </div>
89 <hr>
90 <div class="refsect2" title="OobsGroupClass">
91 <a name="OobsGroupClass"></a><h3>OobsGroupClass</h3>
92 <pre class="programlisting">typedef struct {
93 OobsObjectClass parent_class;
94
95 void (*_oobs_padding1) (void);
96 void (*_oobs_padding2) (void);
97 } OobsGroupClass;
98 </pre>
99 <p>
100 </p>
101 </div>
102 <hr>
103 <div class="refsect2" title="oobs_group_new ()">
104 <a name="oobs-group-new"></a><h3>oobs_group_new ()</h3>
105 <pre class="programlisting"><a class="link" href="OobsGroup.html" title="OobsGroup"><span class="returnvalue">OobsGroup</span></a>* oobs_group_new (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre>
106 <p>
107 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>.
108 </p>
109 <div class="variablelist"><table border="0">
110 <col align="left" valign="top">
111 <tbody>
112 <tr>
113 <td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td>
114 <td>group name.
115 </td>
116 </tr>
117 <tr>
118 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
119 <td> A new <a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a>.
120 </td>
121 </tr>
122 </tbody>
123 </table></div>
124 </div>
125 <hr>
126 <div class="refsect2" title="oobs_group_get_name ()">
127 <a name="oobs-group-get-name"></a><h3>oobs_group_get_name ()</h3>
128 <pre class="programlisting">const <span class="returnvalue">gchar</span>* oobs_group_get_name (<em class="parameter"><code><a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a> *group</code></em>);</pre>
129 <p>
130 Returns the name of the group represented by <em class="parameter"><code>group</code></em>.
131 </p>
132 <div class="variablelist"><table border="0">
133 <col align="left" valign="top">
134 <tbody>
135 <tr>
136 <td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td>
137 <td>An <a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a>.
138 </td>
139 </tr>
140 <tr>
141 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
142 <td> A pointer to the group name as a string.
143 This string must not be freed, modified or stored.
144 </td>
145 </tr>
146 </tbody>
147 </table></div>
148 </div>
149 <hr>
150 <div class="refsect2" title="oobs_group_set_password ()">
151 <a name="oobs-group-set-password"></a><h3>oobs_group_set_password ()</h3>
152 <pre class="programlisting"><span class="returnvalue">void</span> oobs_group_set_password (<em class="parameter"><code><a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a> *group</code></em>,
153 <em class="parameter"><code>const <span class="type">gchar</span> *password</code></em>);</pre>
154 <p>
155 </p>
156 <div class="variablelist"><table border="0">
157 <col align="left" valign="top">
158 <tbody>
159 <tr>
160 <td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td>
161 <td>
162 </td>
163 </tr>
164 <tr>
165 <td><p><span class="term"><em class="parameter"><code>password</code></em> :</span></p></td>
166 <td>
167 </td>
168 </tr>
169 </tbody>
170 </table></div>
171 </div>
172 <hr>
173 <div class="refsect2" title="oobs_group_get_gid ()">
174 <a name="oobs-group-get-gid"></a><h3>oobs_group_get_gid ()</h3>
175 <pre class="programlisting"><span class="returnvalue">gid_t</span> oobs_group_get_gid (<em class="parameter"><code><a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a> *group</code></em>);</pre>
176 <p>
177 Returns the group ID (GID) associated to <a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a>
178 </p>
179 <div class="variablelist"><table border="0">
180 <col align="left" valign="top">
181 <tbody>
182 <tr>
183 <td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td>
184 <td>An <a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a>.
185 </td>
186 </tr>
187 <tr>
188 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
189 <td> the <span class="type">group</span> GID.
190 </td>
191 </tr>
192 </tbody>
193 </table></div>
194 </div>
195 <hr>
196 <div class="refsect2" title="oobs_group_set_gid ()">
197 <a name="oobs-group-set-gid"></a><h3>oobs_group_set_gid ()</h3>
198 <pre class="programlisting"><span class="returnvalue">void</span> oobs_group_set_gid (<em class="parameter"><code><a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a> *group</code></em>,
199 <em class="parameter"><code><span class="type">gid_t</span> gid</code></em>);</pre>
200 <p>
201 Sets the group ID (GID) of <span class="type">group</span> to be <span class="type">gid</span>.
202 </p>
203 <div class="variablelist"><table border="0">
204 <col align="left" valign="top">
205 <tbody>
206 <tr>
207 <td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td>
208 <td>An <a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a>.
209 </td>
210 </tr>
211 <tr>
212 <td><p><span class="term"><em class="parameter"><code>gid</code></em> :</span></p></td>
213 <td>A new GID for <span class="type">group</span>.
214 </td>
215 </tr>
216 </tbody>
217 </table></div>
218 </div>
219 <hr>
220 <div class="refsect2" title="oobs_group_get_users ()">
221 <a name="oobs-group-get-users"></a><h3>oobs_group_get_users ()</h3>
222 <pre class="programlisting"><span class="returnvalue">GList</span> * oobs_group_get_users (<em class="parameter"><code><a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a> *group</code></em>);</pre>
223 <p>
224 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
225 that represent the users represented by the group.
226 </p>
227 <div class="variablelist"><table border="0">
228 <col align="left" valign="top">
229 <tbody>
230 <tr>
231 <td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td>
232 <td>An <a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a>.
233 </td>
234 </tr>
235 <tr>
236 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
237 <td> a newly allocated <span class="type">GList</span>, use <code class="function">g_list_free()</code> to free it.
238 </td>
239 </tr>
240 </tbody>
241 </table></div>
242 </div>
243 <hr>
244 <div class="refsect2" title="oobs_group_clear_users ()">
245 <a name="oobs-group-clear-users"></a><h3>oobs_group_clear_users ()</h3>
246 <pre class="programlisting"><span class="returnvalue">void</span> oobs_group_clear_users (<em class="parameter"><code><a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a> *group</code></em>);</pre>
247 <p>
248 </p>
249 <div class="variablelist"><table border="0">
250 <col align="left" valign="top">
251 <tbody><tr>
252 <td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td>
253 <td>
254 </td>
255 </tr></tbody>
256 </table></div>
257 </div>
258 <hr>
259 <div class="refsect2" title="oobs_group_add_user ()">
260 <a name="oobs-group-add-user"></a><h3>oobs_group_add_user ()</h3>
261 <pre class="programlisting"><span class="returnvalue">void</span> oobs_group_add_user (<em class="parameter"><code><a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a> *group</code></em>,
262 <em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>);</pre>
263 <p>
264 Adds a new user to the group. If the user is
265 already in the group, it does nothing.
266 </p>
267 <div class="variablelist"><table border="0">
268 <col align="left" valign="top">
269 <tbody>
270 <tr>
271 <td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td>
272 <td>An <a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a>.
273 </td>
274 </tr>
275 <tr>
276 <td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
277 <td>An <a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> to add to the group.
278 </td>
279 </tr>
280 </tbody>
281 </table></div>
282 </div>
283 <hr>
284 <div class="refsect2" title="oobs_group_remove_user ()">
285 <a name="oobs-group-remove-user"></a><h3>oobs_group_remove_user ()</h3>
286 <pre class="programlisting"><span class="returnvalue">void</span> oobs_group_remove_user (<em class="parameter"><code><a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a> *group</code></em>,
287 <em class="parameter"><code><a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> *user</code></em>);</pre>
288 <p>
289 Removes an user from the group. If the user isn't a
290 member of this group, this function does nothing.
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>group</code></em> :</span></p></td>
297 <td>An <a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a>.
298 </td>
299 </tr>
300 <tr>
301 <td><p><span class="term"><em class="parameter"><code>user</code></em> :</span></p></td>
302 <td>An <a class="link" href="OobsUser.html" title="OobsUser"><span class="type">OobsUser</span></a> to remove from the group.
303 </td>
304 </tr>
305 </tbody>
306 </table></div>
307 </div>
308 <hr>
309 <div class="refsect2" title="oobs_group_is_root ()">
310 <a name="oobs-group-is-root"></a><h3>oobs_group_is_root ()</h3>
311 <pre class="programlisting"><span class="returnvalue">gboolean</span> oobs_group_is_root (<em class="parameter"><code><a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a> *group</code></em>);</pre>
312 <p>
313 Checks whether a group is the root group, according to its name.
314 </p>
315 <div class="variablelist"><table border="0">
316 <col align="left" valign="top">
317 <tbody>
318 <tr>
319 <td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td>
320 <td>An <a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a>.
321 </td>
322 </tr>
323 <tr>
324 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
325 <td> <code class="literal">TRUE</code> if <em class="parameter"><code>group</code></em> is the root group, <code class="literal">FALSE</code> otherwise.
326 </td>
327 </tr>
328 </tbody>
329 </table></div>
330 </div>
331 </div>
332 <div class="refsect1" title="Property Details">
333 <a name="OobsGroup.property-details"></a><h2>Property Details</h2>
334 <div class="refsect2" title='The "gid" property'>
335 <a name="OobsGroup--gid"></a><h3>The <code class="literal">"gid"</code> property</h3>
336 <pre class="programlisting"> "gid" <span class="type">guint</span> : Read / Write</pre>
337 <p>Main group GID for the group.</p>
338 <p>Allowed values: &lt;= G_MAXINT</p>
339 <p>Default value: 2147483647</p>
340 </div>
341 <hr>
342 <div class="refsect2" title='The "name" property'>
343 <a name="OobsGroup--name"></a><h3>The <code class="literal">"name"</code> property</h3>
344 <pre class="programlisting"> "name" <span class="type">gchar</span>* : Read / Write / Construct Only</pre>
345 <p>Name for the group.</p>
346 <p>Default value: NULL</p>
347 </div>
348 <hr>
349 <div class="refsect2" title='The "password" property'>
350 <a name="OobsGroup--password"></a><h3>The <code class="literal">"password"</code> property</h3>
351 <pre class="programlisting"> "password" <span class="type">gchar</span>* : Read / Write</pre>
352 <p>Password for the group.</p>
353 <p>Default value: NULL</p>
354 </div>
355 </div>
356 <div class="refsect1" title="See Also">
357 <a name="OobsGroup.see-also"></a><h2>See Also</h2>
358 <a class="link" href="OobsGroupsConfig.html" title="OobsGroupsConfig"><span class="type">OobsGroupsConfig</span></a>
359 </div>
360 </div>
361 <div class="footer">
362 <hr>
363 Generated by GTK-Doc V1.15</div>
364 </body>
365 </html>