| 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>OobsGroupsConfig</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="ch02.html" title="Users and groups management"> |
| 10 |
<link rel="next" href="OobsUsersConfig.html" title="OobsUsersConfig"> |
| 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="ch02.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="OobsUsersConfig.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="#OobsGroupsConfig.synopsis" class="shortcut">Top</a> |
| 25 |
| |
| 26 |
<a href="#OobsGroupsConfig.description" class="shortcut">Description</a> |
| 27 |
| |
| 28 |
<a href="#OobsGroupsConfig.object-hierarchy" class="shortcut">Object Hierarchy</a> |
| 29 |
| |
| 30 |
<a href="#OobsGroupsConfig.properties" class="shortcut">Properties</a> |
| 31 |
</td></tr> |
| 32 |
</table> |
| 33 |
<div class="refentry" title="OobsGroupsConfig"> |
| 34 |
<a name="OobsGroupsConfig"></a><div class="titlepage"></div> |
| 35 |
<div class="refnamediv"><table width="100%"><tr> |
| 36 |
<td valign="top"> |
| 37 |
<h2><span class="refentrytitle"><a name="OobsGroupsConfig.top_of_page"></a>OobsGroupsConfig</span></h2> |
| 38 |
<p>OobsGroupsConfig — Object that represents groups configuration</p> |
| 39 |
</td> |
| 40 |
<td valign="top" align="right"></td> |
| 41 |
</tr></table></div> |
| 42 |
<div class="refsynopsisdiv" title="Synopsis"> |
| 43 |
<a name="OobsGroupsConfig.synopsis"></a><h2>Synopsis</h2> |
| 44 |
<pre class="synopsis"> <a class="link" href="OobsGroupsConfig.html#OobsGroupsConfig-struct" title="OobsGroupsConfig">OobsGroupsConfig</a>; |
| 45 |
<a class="link" href="OobsGroupsConfig.html#OobsGroupsConfigClass" title="OobsGroupsConfigClass">OobsGroupsConfigClass</a>; |
| 46 |
<a class="link" href="OobsObject.html" title="OobsObject"><span class="returnvalue">OobsObject</span></a>* <a class="link" href="OobsGroupsConfig.html#oobs-groups-config-get" title="oobs_groups_config_get ()">oobs_groups_config_get</a> (<em class="parameter"><code><span class="type">void</span></code></em>); |
| 47 |
<a class="link" href="OobsList.html" title="OobsList"><span class="returnvalue">OobsList</span></a>* <a class="link" href="OobsGroupsConfig.html#oobs-groups-config-get-groups" title="oobs_groups_config_get_groups ()">oobs_groups_config_get_groups</a> (<em class="parameter"><code><a class="link" href="OobsGroupsConfig.html" title="OobsGroupsConfig"><span class="type">OobsGroupsConfig</span></a> *config</code></em>); |
| 48 |
<span class="returnvalue">OobsResult</span> <a class="link" href="OobsGroupsConfig.html#oobs-groups-config-add-group" title="oobs_groups_config_add_group ()">oobs_groups_config_add_group</a> (<em class="parameter"><code><a class="link" href="OobsGroupsConfig.html" title="OobsGroupsConfig"><span class="type">OobsGroupsConfig</span></a> *config</code></em>, |
| 49 |
<em class="parameter"><code><a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a> *group</code></em>); |
| 50 |
<span class="returnvalue">OobsResult</span> <a class="link" href="OobsGroupsConfig.html#oobs-groups-config-delete-group" title="oobs_groups_config_delete_group ()">oobs_groups_config_delete_group</a> (<em class="parameter"><code><a class="link" href="OobsGroupsConfig.html" title="OobsGroupsConfig"><span class="type">OobsGroupsConfig</span></a> *config</code></em>, |
| 51 |
<em class="parameter"><code><a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a> *group</code></em>); |
| 52 |
<a class="link" href="OobsGroup.html" title="OobsGroup"><span class="returnvalue">OobsGroup</span></a>* <a class="link" href="OobsGroupsConfig.html#oobs-groups-config-get-from-name" title="oobs_groups_config_get_from_name ()">oobs_groups_config_get_from_name</a> (<em class="parameter"><code><a class="link" href="OobsGroupsConfig.html" title="OobsGroupsConfig"><span class="type">OobsGroupsConfig</span></a> *config</code></em>, |
| 53 |
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>); |
| 54 |
<a class="link" href="OobsGroup.html" title="OobsGroup"><span class="returnvalue">OobsGroup</span></a>* <a class="link" href="OobsGroupsConfig.html#oobs-groups-config-get-from-gid" title="oobs_groups_config_get_from_gid ()">oobs_groups_config_get_from_gid</a> (<em class="parameter"><code><a class="link" href="OobsGroupsConfig.html" title="OobsGroupsConfig"><span class="type">OobsGroupsConfig</span></a> *config</code></em>, |
| 55 |
<em class="parameter"><code><span class="type">gid_t</span> gid</code></em>); |
| 56 |
<span class="returnvalue">gboolean</span> <a class="link" href="OobsGroupsConfig.html#oobs-groups-config-is-name-used" title="oobs_groups_config_is_name_used ()">oobs_groups_config_is_name_used</a> (<em class="parameter"><code><a class="link" href="OobsGroupsConfig.html" title="OobsGroupsConfig"><span class="type">OobsGroupsConfig</span></a> *config</code></em>, |
| 57 |
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>); |
| 58 |
<span class="returnvalue">gboolean</span> <a class="link" href="OobsGroupsConfig.html#oobs-groups-config-is-gid-used" title="oobs_groups_config_is_gid_used ()">oobs_groups_config_is_gid_used</a> (<em class="parameter"><code><a class="link" href="OobsGroupsConfig.html" title="OobsGroupsConfig"><span class="type">OobsGroupsConfig</span></a> *config</code></em>, |
| 59 |
<em class="parameter"><code><span class="type">gid_t</span> gid</code></em>); |
| 60 |
<span class="returnvalue">gid_t</span> <a class="link" href="OobsGroupsConfig.html#oobs-groups-config-find-free-gid" title="oobs_groups_config_find_free_gid ()">oobs_groups_config_find_free_gid</a> (<em class="parameter"><code><a class="link" href="OobsGroupsConfig.html" title="OobsGroupsConfig"><span class="type">OobsGroupsConfig</span></a> *config</code></em>, |
| 61 |
<em class="parameter"><code><span class="type">gid_t</span> gid_min</code></em>, |
| 62 |
<em class="parameter"><code><span class="type">gid_t</span> gid_max</code></em>); |
| 63 |
</pre> |
| 64 |
</div> |
| 65 |
<div class="refsect1" title="Object Hierarchy"> |
| 66 |
<a name="OobsGroupsConfig.object-hierarchy"></a><h2>Object Hierarchy</h2> |
| 67 |
<pre class="synopsis"> |
| 68 |
GObject |
| 69 |
+----<a class="link" href="OobsObject.html" title="OobsObject">OobsObject</a> |
| 70 |
+----OobsGroupsConfig |
| 71 |
</pre> |
| 72 |
</div> |
| 73 |
<div class="refsect1" title="Properties"> |
| 74 |
<a name="OobsGroupsConfig.properties"></a><h2>Properties</h2> |
| 75 |
<pre class="synopsis"> |
| 76 |
"<a class="link" href="OobsGroupsConfig.html#OobsGroupsConfig--maximum-gid" title='The "maximum-gid" property'>maximum-gid</a>" <span class="type">gint</span> : Read / Write |
| 77 |
"<a class="link" href="OobsGroupsConfig.html#OobsGroupsConfig--minimum-gid" title='The "minimum-gid" property'>minimum-gid</a>" <span class="type">gint</span> : Read / Write |
| 78 |
</pre> |
| 79 |
</div> |
| 80 |
<div class="refsect1" title="Description"> |
| 81 |
<a name="OobsGroupsConfig.description"></a><h2>Description</h2> |
| 82 |
</div> |
| 83 |
<div class="refsect1" title="Details"> |
| 84 |
<a name="OobsGroupsConfig.details"></a><h2>Details</h2> |
| 85 |
<div class="refsect2" title="OobsGroupsConfig"> |
| 86 |
<a name="OobsGroupsConfig-struct"></a><h3>OobsGroupsConfig</h3> |
| 87 |
<pre class="programlisting">typedef struct _OobsGroupsConfig OobsGroupsConfig;</pre> |
| 88 |
<p> |
| 89 |
</p> |
| 90 |
</div> |
| 91 |
<hr> |
| 92 |
<div class="refsect2" title="OobsGroupsConfigClass"> |
| 93 |
<a name="OobsGroupsConfigClass"></a><h3>OobsGroupsConfigClass</h3> |
| 94 |
<pre class="programlisting">typedef struct { |
| 95 |
OobsObjectClass parent_class; |
| 96 |
|
| 97 |
void (*_oobs_padding1) (void); |
| 98 |
void (*_oobs_padding2) (void); |
| 99 |
void (*_oobs_padding3) (void); |
| 100 |
void (*_oobs_padding4) (void); |
| 101 |
} OobsGroupsConfigClass; |
| 102 |
</pre> |
| 103 |
<p> |
| 104 |
</p> |
| 105 |
</div> |
| 106 |
<hr> |
| 107 |
<div class="refsect2" title="oobs_groups_config_get ()"> |
| 108 |
<a name="oobs-groups-config-get"></a><h3>oobs_groups_config_get ()</h3> |
| 109 |
<pre class="programlisting"><a class="link" href="OobsObject.html" title="OobsObject"><span class="returnvalue">OobsObject</span></a>* oobs_groups_config_get (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> |
| 110 |
<p> |
| 111 |
Returns the <a class="link" href="OobsGroupsConfig.html" title="OobsGroupsConfig"><span class="type">OobsGroupsConfig</span></a> singleton, which |
| 112 |
represents the groups configuration. |
| 113 |
</p> |
| 114 |
<div class="variablelist"><table border="0"> |
| 115 |
<col align="left" valign="top"> |
| 116 |
<tbody><tr> |
| 117 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 118 |
<td> the singleton <span class="type">OobsGoupsConfig</span> |
| 119 |
</td> |
| 120 |
</tr></tbody> |
| 121 |
</table></div> |
| 122 |
</div> |
| 123 |
<hr> |
| 124 |
<div class="refsect2" title="oobs_groups_config_get_groups ()"> |
| 125 |
<a name="oobs-groups-config-get-groups"></a><h3>oobs_groups_config_get_groups ()</h3> |
| 126 |
<pre class="programlisting"><a class="link" href="OobsList.html" title="OobsList"><span class="returnvalue">OobsList</span></a>* oobs_groups_config_get_groups (<em class="parameter"><code><a class="link" href="OobsGroupsConfig.html" title="OobsGroupsConfig"><span class="type">OobsGroupsConfig</span></a> *config</code></em>);</pre> |
| 127 |
<p> |
| 128 |
Returns an <a class="link" href="OobsList.html" title="OobsList"><span class="type">OobsList</span></a> containing objects of type <a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a>. |
| 129 |
</p> |
| 130 |
<div class="variablelist"><table border="0"> |
| 131 |
<col align="left" valign="top"> |
| 132 |
<tbody> |
| 133 |
<tr> |
| 134 |
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td> |
| 135 |
<td>An <a class="link" href="OobsGroupsConfig.html" title="OobsGroupsConfig"><span class="type">OobsGroupsConfig</span></a>. |
| 136 |
</td> |
| 137 |
</tr> |
| 138 |
<tr> |
| 139 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 140 |
<td> An OobsList containing the groups configuration. |
| 141 |
</td> |
| 142 |
</tr> |
| 143 |
</tbody> |
| 144 |
</table></div> |
| 145 |
</div> |
| 146 |
<hr> |
| 147 |
<div class="refsect2" title="oobs_groups_config_add_group ()"> |
| 148 |
<a name="oobs-groups-config-add-group"></a><h3>oobs_groups_config_add_group ()</h3> |
| 149 |
<pre class="programlisting"><span class="returnvalue">OobsResult</span> oobs_groups_config_add_group (<em class="parameter"><code><a class="link" href="OobsGroupsConfig.html" title="OobsGroupsConfig"><span class="type">OobsGroupsConfig</span></a> *config</code></em>, |
| 150 |
<em class="parameter"><code><a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a> *group</code></em>);</pre> |
| 151 |
<p> |
| 152 |
Add a group to the configuration, immediately committing changes to the system. |
| 153 |
On success, <em class="parameter"><code>group</code></em> will be appended to the groups list. |
| 154 |
</p> |
| 155 |
<div class="variablelist"><table border="0"> |
| 156 |
<col align="left" valign="top"> |
| 157 |
<tbody> |
| 158 |
<tr> |
| 159 |
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td> |
| 160 |
<td>An <a class="link" href="OobsGroupsConfig.html" title="OobsGroupsConfig"><span class="type">OobsGroupsConfig</span></a>. |
| 161 |
</td> |
| 162 |
</tr> |
| 163 |
<tr> |
| 164 |
<td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td> |
| 165 |
<td>An <span class="type">Oobsgroup</span>. |
| 166 |
</td> |
| 167 |
</tr> |
| 168 |
<tr> |
| 169 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 170 |
<td> an <span class="type">OobsResult</span> enum with the error code. |
| 171 |
</td> |
| 172 |
</tr> |
| 173 |
</tbody> |
| 174 |
</table></div> |
| 175 |
</div> |
| 176 |
<hr> |
| 177 |
<div class="refsect2" title="oobs_groups_config_delete_group ()"> |
| 178 |
<a name="oobs-groups-config-delete-group"></a><h3>oobs_groups_config_delete_group ()</h3> |
| 179 |
<pre class="programlisting"><span class="returnvalue">OobsResult</span> oobs_groups_config_delete_group (<em class="parameter"><code><a class="link" href="OobsGroupsConfig.html" title="OobsGroupsConfig"><span class="type">OobsGroupsConfig</span></a> *config</code></em>, |
| 180 |
<em class="parameter"><code><a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a> *group</code></em>);</pre> |
| 181 |
<p> |
| 182 |
Delete an group from the configuration, immediately committing changes to the system. |
| 183 |
On success, <em class="parameter"><code>group</code></em> will be removed from the groups list. |
| 184 |
</p> |
| 185 |
<div class="variablelist"><table border="0"> |
| 186 |
<col align="left" valign="top"> |
| 187 |
<tbody> |
| 188 |
<tr> |
| 189 |
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td> |
| 190 |
<td>An <a class="link" href="OobsGroupsConfig.html" title="OobsGroupsConfig"><span class="type">OobsGroupsConfig</span></a>. |
| 191 |
</td> |
| 192 |
</tr> |
| 193 |
<tr> |
| 194 |
<td><p><span class="term"><em class="parameter"><code>group</code></em> :</span></p></td> |
| 195 |
<td>An <a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a>. |
| 196 |
</td> |
| 197 |
</tr> |
| 198 |
<tr> |
| 199 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 200 |
<td> an <span class="type">OobsResult</span> enum with the error code. |
| 201 |
</td> |
| 202 |
</tr> |
| 203 |
</tbody> |
| 204 |
</table></div> |
| 205 |
</div> |
| 206 |
<hr> |
| 207 |
<div class="refsect2" title="oobs_groups_config_get_from_name ()"> |
| 208 |
<a name="oobs-groups-config-get-from-name"></a><h3>oobs_groups_config_get_from_name ()</h3> |
| 209 |
<pre class="programlisting"><a class="link" href="OobsGroup.html" title="OobsGroup"><span class="returnvalue">OobsGroup</span></a>* oobs_groups_config_get_from_name (<em class="parameter"><code><a class="link" href="OobsGroupsConfig.html" title="OobsGroupsConfig"><span class="type">OobsGroupsConfig</span></a> *config</code></em>, |
| 210 |
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre> |
| 211 |
<p> |
| 212 |
Gets the (first) group called <em class="parameter"><code>name</code></em>. This is a convenience function |
| 213 |
to avoid walking manually over the groups list. |
| 214 |
</p> |
| 215 |
<div class="variablelist"><table border="0"> |
| 216 |
<col align="left" valign="top"> |
| 217 |
<tbody> |
| 218 |
<tr> |
| 219 |
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td> |
| 220 |
<td>An <a class="link" href="OobsGroupsConfig.html" title="OobsGroupsConfig"><span class="type">OobsGroupsConfig</span></a>. |
| 221 |
</td> |
| 222 |
</tr> |
| 223 |
<tr> |
| 224 |
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> |
| 225 |
<td>the name of the wanted group. |
| 226 |
</td> |
| 227 |
</tr> |
| 228 |
<tr> |
| 229 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 230 |
<td> an <a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a> corresponding to the passed named, |
| 231 |
or <code class="literal">NULL</code> if no such group exists. Don't forget to unref group when you're done. |
| 232 |
</td> |
| 233 |
</tr> |
| 234 |
</tbody> |
| 235 |
</table></div> |
| 236 |
</div> |
| 237 |
<hr> |
| 238 |
<div class="refsect2" title="oobs_groups_config_get_from_gid ()"> |
| 239 |
<a name="oobs-groups-config-get-from-gid"></a><h3>oobs_groups_config_get_from_gid ()</h3> |
| 240 |
<pre class="programlisting"><a class="link" href="OobsGroup.html" title="OobsGroup"><span class="returnvalue">OobsGroup</span></a>* oobs_groups_config_get_from_gid (<em class="parameter"><code><a class="link" href="OobsGroupsConfig.html" title="OobsGroupsConfig"><span class="type">OobsGroupsConfig</span></a> *config</code></em>, |
| 241 |
<em class="parameter"><code><span class="type">gid_t</span> gid</code></em>);</pre> |
| 242 |
<p> |
| 243 |
Gets the (first) group whose GID is <em class="parameter"><code>gid</code></em>. This is a convenience function |
| 244 |
to avoid walking manually over the groups list. |
| 245 |
</p> |
| 246 |
<div class="variablelist"><table border="0"> |
| 247 |
<col align="left" valign="top"> |
| 248 |
<tbody> |
| 249 |
<tr> |
| 250 |
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td> |
| 251 |
<td>An <a class="link" href="OobsGroupsConfig.html" title="OobsGroupsConfig"><span class="type">OobsGroupsConfig</span></a>. |
| 252 |
</td> |
| 253 |
</tr> |
| 254 |
<tr> |
| 255 |
<td><p><span class="term"><em class="parameter"><code>gid</code></em> :</span></p></td> |
| 256 |
<td>the GID of the wanted group. |
| 257 |
</td> |
| 258 |
</tr> |
| 259 |
<tr> |
| 260 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 261 |
<td> an <a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a> corresponding to the passed GID, |
| 262 |
or <code class="literal">NULL</code> if no such group exists. Don't forget to group user when you're done. |
| 263 |
</td> |
| 264 |
</tr> |
| 265 |
</tbody> |
| 266 |
</table></div> |
| 267 |
</div> |
| 268 |
<hr> |
| 269 |
<div class="refsect2" title="oobs_groups_config_is_name_used ()"> |
| 270 |
<a name="oobs-groups-config-is-name-used"></a><h3>oobs_groups_config_is_name_used ()</h3> |
| 271 |
<pre class="programlisting"><span class="returnvalue">gboolean</span> oobs_groups_config_is_name_used (<em class="parameter"><code><a class="link" href="OobsGroupsConfig.html" title="OobsGroupsConfig"><span class="type">OobsGroupsConfig</span></a> *config</code></em>, |
| 272 |
<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>);</pre> |
| 273 |
<p> |
| 274 |
Check whether <em class="parameter"><code>name</code></em> is already used by an existing group or not. This is |
| 275 |
a convenience function to avoid walking manually over the groups list. |
| 276 |
</p> |
| 277 |
<div class="variablelist"><table border="0"> |
| 278 |
<col align="left" valign="top"> |
| 279 |
<tbody> |
| 280 |
<tr> |
| 281 |
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td> |
| 282 |
<td>An <a class="link" href="OobsGroupsConfig.html" title="OobsGroupsConfig"><span class="type">OobsGroupsConfig</span></a>. |
| 283 |
</td> |
| 284 |
</tr> |
| 285 |
<tr> |
| 286 |
<td><p><span class="term"><em class="parameter"><code>name</code></em> :</span></p></td> |
| 287 |
<td>the name to check. |
| 288 |
</td> |
| 289 |
</tr> |
| 290 |
<tr> |
| 291 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 292 |
<td> <code class="literal">TRUE</code> if a group called <em class="parameter"><code>name</code></em> already exists, <code class="literal">FALSE</code> otherwise. |
| 293 |
</td> |
| 294 |
</tr> |
| 295 |
</tbody> |
| 296 |
</table></div> |
| 297 |
</div> |
| 298 |
<hr> |
| 299 |
<div class="refsect2" title="oobs_groups_config_is_gid_used ()"> |
| 300 |
<a name="oobs-groups-config-is-gid-used"></a><h3>oobs_groups_config_is_gid_used ()</h3> |
| 301 |
<pre class="programlisting"><span class="returnvalue">gboolean</span> oobs_groups_config_is_gid_used (<em class="parameter"><code><a class="link" href="OobsGroupsConfig.html" title="OobsGroupsConfig"><span class="type">OobsGroupsConfig</span></a> *config</code></em>, |
| 302 |
<em class="parameter"><code><span class="type">gid_t</span> gid</code></em>);</pre> |
| 303 |
<p> |
| 304 |
Check whether <em class="parameter"><code>gid</code></em> is already used by an existing group or not. This is |
| 305 |
a convenience function to avoid walking manually over the groups list. |
| 306 |
</p> |
| 307 |
<div class="variablelist"><table border="0"> |
| 308 |
<col align="left" valign="top"> |
| 309 |
<tbody> |
| 310 |
<tr> |
| 311 |
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td> |
| 312 |
<td>An <a class="link" href="OobsGroupsConfig.html" title="OobsGroupsConfig"><span class="type">OobsGroupsConfig</span></a>. |
| 313 |
</td> |
| 314 |
</tr> |
| 315 |
<tr> |
| 316 |
<td><p><span class="term"><em class="parameter"><code>gid</code></em> :</span></p></td> |
| 317 |
<td>the gid to check. |
| 318 |
</td> |
| 319 |
</tr> |
| 320 |
<tr> |
| 321 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 322 |
<td> <code class="literal">TRUE</code> if an group with such an gid already exists, <code class="literal">FALSE</code> otherwise. |
| 323 |
</td> |
| 324 |
</tr> |
| 325 |
</tbody> |
| 326 |
</table></div> |
| 327 |
</div> |
| 328 |
<hr> |
| 329 |
<div class="refsect2" title="oobs_groups_config_find_free_gid ()"> |
| 330 |
<a name="oobs-groups-config-find-free-gid"></a><h3>oobs_groups_config_find_free_gid ()</h3> |
| 331 |
<pre class="programlisting"><span class="returnvalue">gid_t</span> oobs_groups_config_find_free_gid (<em class="parameter"><code><a class="link" href="OobsGroupsConfig.html" title="OobsGroupsConfig"><span class="type">OobsGroupsConfig</span></a> *config</code></em>, |
| 332 |
<em class="parameter"><code><span class="type">gid_t</span> gid_min</code></em>, |
| 333 |
<em class="parameter"><code><span class="type">gid_t</span> gid_max</code></em>);</pre> |
| 334 |
<p> |
| 335 |
</p> |
| 336 |
<div class="variablelist"><table border="0"> |
| 337 |
<col align="left" valign="top"> |
| 338 |
<tbody> |
| 339 |
<tr> |
| 340 |
<td><p><span class="term"><em class="parameter"><code>config</code></em> :</span></p></td> |
| 341 |
<td> |
| 342 |
</td> |
| 343 |
</tr> |
| 344 |
<tr> |
| 345 |
<td><p><span class="term"><em class="parameter"><code>gid_min</code></em> :</span></p></td> |
| 346 |
<td> |
| 347 |
</td> |
| 348 |
</tr> |
| 349 |
<tr> |
| 350 |
<td><p><span class="term"><em class="parameter"><code>gid_max</code></em> :</span></p></td> |
| 351 |
<td> |
| 352 |
</td> |
| 353 |
</tr> |
| 354 |
<tr> |
| 355 |
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> |
| 356 |
<td> |
| 357 |
</td> |
| 358 |
</tr> |
| 359 |
</tbody> |
| 360 |
</table></div> |
| 361 |
</div> |
| 362 |
</div> |
| 363 |
<div class="refsect1" title="Property Details"> |
| 364 |
<a name="OobsGroupsConfig.property-details"></a><h2>Property Details</h2> |
| 365 |
<div class="refsect2" title='The "maximum-gid" property'> |
| 366 |
<a name="OobsGroupsConfig--maximum-gid"></a><h3>The <code class="literal">"maximum-gid"</code> property</h3> |
| 367 |
<pre class="programlisting"> "maximum-gid" <span class="type">gint</span> : Read / Write</pre> |
| 368 |
<p>Maximum GID for non-system groups.</p> |
| 369 |
<p>Allowed values: >= 0</p> |
| 370 |
<p>Default value: 2147483647</p> |
| 371 |
</div> |
| 372 |
<hr> |
| 373 |
<div class="refsect2" title='The "minimum-gid" property'> |
| 374 |
<a name="OobsGroupsConfig--minimum-gid"></a><h3>The <code class="literal">"minimum-gid"</code> property</h3> |
| 375 |
<pre class="programlisting"> "minimum-gid" <span class="type">gint</span> : Read / Write</pre> |
| 376 |
<p>Minimum GID for non-system groups.</p> |
| 377 |
<p>Allowed values: >= 0</p> |
| 378 |
<p>Default value: 2147483647</p> |
| 379 |
</div> |
| 380 |
</div> |
| 381 |
<div class="refsect1" title="See Also"> |
| 382 |
<a name="OobsGroupsConfig.see-also"></a><h2>See Also</h2> |
| 383 |
<a class="link" href="OobsGroup.html" title="OobsGroup"><span class="type">OobsGroup</span></a> |
| 384 |
</div> |
| 385 |
</div> |
| 386 |
<div class="footer"> |
| 387 |
<hr> |
| 388 |
Generated by GTK-Doc V1.15</div> |
| 389 |
</body> |
| 390 |
</html> |