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
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY version SYSTEM "version.xml">
]>
<refentry id="OobsGroup">
<refmeta>
<refentrytitle role="top_of_page" id="OobsGroup.top_of_page">OobsGroup</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBOOBS Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>OobsGroup</refname>
<refpurpose>Object that represents an individual group.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv id="OobsGroup.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="OobsGroup-struct">OobsGroup</link>;
<link linkend="OobsGroup">OobsGroup</link>* <link linkend="oobs-group-new">oobs_group_new</link> (const <link linkend="gchar">gchar</link> *name);
const <link linkend="gchar">gchar</link>* <link linkend="oobs-group-get-name">oobs_group_get_name</link> (<link linkend="OobsGroup">OobsGroup</link> *group);
<link linkend="void">void</link> <link linkend="oobs-group-set-password">oobs_group_set_password</link> (<link linkend="OobsGroup">OobsGroup</link> *group,
const <link linkend="gchar">gchar</link> *password);
<link linkend="void">void</link> <link linkend="oobs-group-set-crypted-password">oobs_group_set_crypted_password</link> (<link linkend="OobsGroup">OobsGroup</link> *group,
const <link linkend="gchar">gchar</link> *crypted_password);
<link linkend="gid-t">gid_t</link> <link linkend="oobs-group-get-gid">oobs_group_get_gid</link> (<link linkend="OobsGroup">OobsGroup</link> *group);
<link linkend="void">void</link> <link linkend="oobs-group-set-gid">oobs_group_set_gid</link> (<link linkend="OobsGroup">OobsGroup</link> *group,
<link linkend="gid-t">gid_t</link> gid);
<link linkend="GList">GList</link>* <link linkend="oobs-group-get-users">oobs_group_get_users</link> (<link linkend="OobsGroup">OobsGroup</link> *group);
<link linkend="void">void</link> <link linkend="oobs-group-add-user">oobs_group_add_user</link> (<link linkend="OobsGroup">OobsGroup</link> *group,
<link linkend="OobsUser">OobsUser</link> *user);
<link linkend="void">void</link> <link linkend="oobs-group-remove-user">oobs_group_remove_user</link> (<link linkend="OobsGroup">OobsGroup</link> *group,
<link linkend="OobsUser">OobsUser</link> *user);
</synopsis>
</refsynopsisdiv>
<refsect1 id="OobsGroup.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
<link linkend="GObject">GObject</link>
+----OobsGroup
</synopsis>
</refsect1>
<refsect1 id="OobsGroup.properties" role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="OobsGroup--crypted-password">crypted-password</link>" <link linkend="gchar">gchar</link>* : Read / Write
"<link linkend="OobsGroup--gid">gid</link>" <link linkend="gint">gint</link> : Read / Write
"<link linkend="OobsGroup--name">name</link>" <link linkend="gchar">gchar</link>* : Read / Write / Construct Only
"<link linkend="OobsGroup--password">password</link>" <link linkend="gchar">gchar</link>* : Write
</synopsis>
</refsect1>
<refsect1 id="OobsGroup.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="OobsGroup.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="OobsGroup-struct" role="struct">
<title>OobsGroup</title>
<indexterm zone="OobsGroup-struct"><primary>OobsGroup</primary></indexterm><programlisting>typedef struct _OobsGroup OobsGroup;</programlisting>
<para>
</para></refsect2>
<refsect2 id="oobs-group-new" role="function">
<title>oobs_group_new ()</title>
<indexterm zone="oobs-group-new"><primary>oobs_group_new</primary></indexterm><programlisting><link linkend="OobsGroup">OobsGroup</link>* oobs_group_new (const <link linkend="gchar">gchar</link> *name);</programlisting>
<para>
Returns a newly allocated <link linkend="OobsGroup"><type>OobsGroup</type></link> with the name specified by <parameter>name</parameter>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> group name.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="OobsGroup"><type>OobsGroup</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-group-get-name" role="function">
<title>oobs_group_get_name ()</title>
<indexterm zone="oobs-group-get-name"><primary>oobs_group_get_name</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* oobs_group_get_name (<link linkend="OobsGroup">OobsGroup</link> *group);</programlisting>
<para>
Returns the name of the group represented by <link linkend="OobsGroup"><type>OobsGroup</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>group</parameter> :</term>
<listitem><simpara> An <link linkend="OobsGroup"><type>OobsGroup</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A pointer to the group name as a string.
This string must not be freed, modified or stored.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-group-set-password" role="function">
<title>oobs_group_set_password ()</title>
<indexterm zone="oobs-group-set-password"><primary>oobs_group_set_password</primary></indexterm><programlisting><link linkend="void">void</link> oobs_group_set_password (<link linkend="OobsGroup">OobsGroup</link> *group,
const <link linkend="gchar">gchar</link> *password);</programlisting>
<para>
Sets the group password for the group defined
by <link linkend="OobsGroup"><type>OobsGroup</type></link>, overwriting the previous one.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>group</parameter> :</term>
<listitem><simpara> An <link linkend="OobsGroup"><type>OobsGroup</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>password</parameter> :</term>
<listitem><simpara> A new password for <link linkend="group"><type>group</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-group-set-crypted-password" role="function">
<title>oobs_group_set_crypted_password ()</title>
<indexterm zone="oobs-group-set-crypted-password"><primary>oobs_group_set_crypted_password</primary></indexterm><programlisting><link linkend="void">void</link> oobs_group_set_crypted_password (<link linkend="OobsGroup">OobsGroup</link> *group,
const <link linkend="gchar">gchar</link> *crypted_password);</programlisting>
<para>
Sets an already crypted password for the group
defined by <link linkend="OobsGroup"><type>OobsGroup</type></link>, overwriting the previous one.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>group</parameter> :</term>
<listitem><simpara> An <link linkend="OobsGroup"><type>OobsGroup</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>crypted_password</parameter> :</term>
<listitem><simpara> a new crypted password for <link linkend="group"><type>group</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-group-get-gid" role="function">
<title>oobs_group_get_gid ()</title>
<indexterm zone="oobs-group-get-gid"><primary>oobs_group_get_gid</primary></indexterm><programlisting><link linkend="gid-t">gid_t</link> oobs_group_get_gid (<link linkend="OobsGroup">OobsGroup</link> *group);</programlisting>
<para>
Returns the group ID (GID) associated to <link linkend="OobsGroup"><type>OobsGroup</type></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>group</parameter> :</term>
<listitem><simpara> An <link linkend="OobsGroup"><type>OobsGroup</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the <link linkend="group"><type>group</type></link> GID.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-group-set-gid" role="function">
<title>oobs_group_set_gid ()</title>
<indexterm zone="oobs-group-set-gid"><primary>oobs_group_set_gid</primary></indexterm><programlisting><link linkend="void">void</link> oobs_group_set_gid (<link linkend="OobsGroup">OobsGroup</link> *group,
<link linkend="gid-t">gid_t</link> gid);</programlisting>
<para>
Sets the group ID (GID) of <link linkend="group"><type>group</type></link> to be <link linkend="gid"><type>gid</type></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>group</parameter> :</term>
<listitem><simpara> An <link linkend="OobsGroup"><type>OobsGroup</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>gid</parameter> :</term>
<listitem><simpara> A new GID for <link linkend="group"><type>group</type></link>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-group-get-users" role="function">
<title>oobs_group_get_users ()</title>
<indexterm zone="oobs-group-get-users"><primary>oobs_group_get_users</primary></indexterm><programlisting><link linkend="GList">GList</link>* oobs_group_get_users (<link linkend="OobsGroup">OobsGroup</link> *group);</programlisting>
<para>
Returns a <link linkend="GList"><type>GList</type></link> containing pointers to the <link linkend="OobsUser"><type>OobsUser</type></link> objects
that represent the users represented by the group.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>group</parameter> :</term>
<listitem><simpara> An <link linkend="OobsGroup"><type>OobsGroup</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a newly allocated <link linkend="GList"><type>GList</type></link>, use <link linkend="g-list-free"><function>g_list_free()</function></link> to free it.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-group-add-user" role="function">
<title>oobs_group_add_user ()</title>
<indexterm zone="oobs-group-add-user"><primary>oobs_group_add_user</primary></indexterm><programlisting><link linkend="void">void</link> oobs_group_add_user (<link linkend="OobsGroup">OobsGroup</link> *group,
<link linkend="OobsUser">OobsUser</link> *user);</programlisting>
<para>
Adds a new user to the group. If the user is
already in the group, it does nothing.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>group</parameter> :</term>
<listitem><simpara> An <link linkend="OobsGroup"><type>OobsGroup</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user</parameter> :</term>
<listitem><simpara> An <link linkend="OobsUser"><type>OobsUser</type></link> to add to the group.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="oobs-group-remove-user" role="function">
<title>oobs_group_remove_user ()</title>
<indexterm zone="oobs-group-remove-user"><primary>oobs_group_remove_user</primary></indexterm><programlisting><link linkend="void">void</link> oobs_group_remove_user (<link linkend="OobsGroup">OobsGroup</link> *group,
<link linkend="OobsUser">OobsUser</link> *user);</programlisting>
<para>
Removes an user from the group. If the user isn't a
member of this group, this function does nothing.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>group</parameter> :</term>
<listitem><simpara> An <link linkend="OobsGroup"><type>OobsGroup</type></link>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user</parameter> :</term>
<listitem><simpara> An <link linkend="OobsUser"><type>OobsUser</type></link> to remove from the group.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 id="OobsGroup.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="OobsGroup--crypted-password"><title>The <literal>"crypted-password"</literal> property</title>
<indexterm zone="OobsGroup--crypted-password"><primary>OobsGroup:crypted-password</primary></indexterm><programlisting> "crypted-password" <link linkend="gchar">gchar</link>* : Read / Write</programlisting>
<para>Crypted password for the group.</para><para>Default value: NULL</para>
</refsect2>
<refsect2 id="OobsGroup--gid"><title>The <literal>"gid"</literal> property</title>
<indexterm zone="OobsGroup--gid"><primary>OobsGroup:gid</primary></indexterm><programlisting> "gid" <link linkend="gint">gint</link> : Read / Write</programlisting>
<para>Main group GID for the group.</para><para>Allowed values: [0,65534]</para>
<para>Default value: 65534</para>
</refsect2>
<refsect2 id="OobsGroup--name"><title>The <literal>"name"</literal> property</title>
<indexterm zone="OobsGroup--name"><primary>OobsGroup:name</primary></indexterm><programlisting> "name" <link linkend="gchar">gchar</link>* : Read / Write / Construct Only</programlisting>
<para>Name for the group.</para><para>Default value: NULL</para>
</refsect2>
<refsect2 id="OobsGroup--password"><title>The <literal>"password"</literal> property</title>
<indexterm zone="OobsGroup--password"><primary>OobsGroup:password</primary></indexterm><programlisting> "password" <link linkend="gchar">gchar</link>* : Write</programlisting>
<para>Password for the group.</para><para>Default value: NULL</para>
</refsect2>
</refsect1>
</refentry>
|
