← Back to branch summary

~ubuntu-branches/ubuntu/wily/libuser/wily

« back to all changes in this revision

Viewing changes to docs/reference/xml/entity.xml

  • Committer: Bazaar Package Importer
  • Author(s): Pierre Habouzit
  • Date: 2006-09-03 21:58:15 UTC
  • mto: (2.1.1 edgy) (1.1.5 upstream) (3.1.1 lenny)
  • mto: This revision was merged to the branch mainline in revision 3.
  • Revision ID: james.westby@ubuntu.com-20060903215815-rtvvfzhaer8ymyp4
Tags: upstream-0.54.6-2.1.dfsg.1
Import upstream version 0.54.6-2.1.dfsg.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/xml/entity.xml
1
1
<refentry id="libuser-entity">
2
2
<refmeta>
3
 
<refentrytitle>entity</refentrytitle>
 
3
<refentrytitle id="top_of_page">entity</refentrytitle>
4
4
<manvolnum>3</manvolnum>
5
5
<refmiscinfo>LIBUSER Library</refmiscinfo>
6
6
</refmeta>
7
7
 
8
8
<refnamediv>
9
 
<refname>entity</refname><refpurpose>
 
9
<refname>entity</refname>
 
10
<refpurpose>
10
11
Functions for manipulating lu_ent structures.</refpurpose>
 
12
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
11
13
</refnamediv>
12
14
 
13
 
<refsynopsisdiv><title>Synopsis</title>
 
15
<refsynopsisdiv id="synopsis">
 
16
<title id="synopsis.title">Synopsis</title>
14
17
 
15
18
<synopsis>
16
19
 
96
99
 
97
100
 
98
101
 
99
 
<refsect1>
100
 
<title>Description</title>
 
102
<refsect1 id="desc">
 
103
<title id="desc.title">Description</title>
101
104
<para>
102
105
entity.h declares functions for manipulating lu_ent structures, which are used
103
106
by libuser, its modules, and applications to hold data about a particular
116
119
</para>
117
120
</refsect1>
118
121
 
119
 
<refsect1>
120
 
<title>Details</title>
 
122
<refsect1 id="details">
 
123
<title id="details.title">Details</title>
121
124
<refsect2>
122
 
<title><anchor id="LU-USERNAME:CAPS"/>LU_USERNAME</title>
 
125
<title><anchor id="LU-USERNAME:CAPS" role="macro"/>LU_USERNAME</title>
123
126
<indexterm><primary>LU_USERNAME</primary></indexterm><programlisting>#define LU_USERNAME                "pw_name"
124
127
</programlisting>
125
128
<para>
126
129
 
127
130
</para></refsect2>
128
131
<refsect2>
129
 
<title><anchor id="LU-USERPASSWORD:CAPS"/>LU_USERPASSWORD</title>
 
132
<title><anchor id="LU-USERPASSWORD:CAPS" role="macro"/>LU_USERPASSWORD</title>
130
133
<indexterm><primary>LU_USERPASSWORD</primary></indexterm><programlisting>#define LU_USERPASSWORD                "pw_passwd"
131
134
</programlisting>
132
135
<para>
133
136
 
134
137
</para></refsect2>
135
138
<refsect2>
136
 
<title><anchor id="LU-UIDNUMBER:CAPS"/>LU_UIDNUMBER</title>
 
139
<title><anchor id="LU-UIDNUMBER:CAPS" role="macro"/>LU_UIDNUMBER</title>
137
140
<indexterm><primary>LU_UIDNUMBER</primary></indexterm><programlisting>#define LU_UIDNUMBER              "pw_uid"
138
141
</programlisting>
139
142
<para>
140
143
 
141
144
</para></refsect2>
142
145
<refsect2>
143
 
<title><anchor id="LU-GIDNUMBER:CAPS"/>LU_GIDNUMBER</title>
 
146
<title><anchor id="LU-GIDNUMBER:CAPS" role="macro"/>LU_GIDNUMBER</title>
144
147
<indexterm><primary>LU_GIDNUMBER</primary></indexterm><programlisting>#define LU_GIDNUMBER              "pw_gid"
145
148
</programlisting>
146
149
<para>
147
150
 
148
151
</para></refsect2>
149
152
<refsect2>
150
 
<title><anchor id="LU-GECOS:CAPS"/>LU_GECOS</title>
 
153
<title><anchor id="LU-GECOS:CAPS" role="macro"/>LU_GECOS</title>
151
154
<indexterm><primary>LU_GECOS</primary></indexterm><programlisting>#define LU_GECOS              "pw_gecos"
152
155
</programlisting>
153
156
<para>
154
157
 
155
158
</para></refsect2>
156
159
<refsect2>
157
 
<title><anchor id="LU-HOMEDIRECTORY:CAPS"/>LU_HOMEDIRECTORY</title>
 
160
<title><anchor id="LU-HOMEDIRECTORY:CAPS" role="macro"/>LU_HOMEDIRECTORY</title>
158
161
<indexterm><primary>LU_HOMEDIRECTORY</primary></indexterm><programlisting>#define LU_HOMEDIRECTORY      "pw_dir"
159
162
</programlisting>
160
163
<para>
161
164
 
162
165
</para></refsect2>
163
166
<refsect2>
164
 
<title><anchor id="LU-LOGINSHELL:CAPS"/>LU_LOGINSHELL</title>
 
167
<title><anchor id="LU-LOGINSHELL:CAPS" role="macro"/>LU_LOGINSHELL</title>
165
168
<indexterm><primary>LU_LOGINSHELL</primary></indexterm><programlisting>#define LU_LOGINSHELL            "pw_shell"
166
169
</programlisting>
167
170
<para>
168
171
 
169
172
</para></refsect2>
170
173
<refsect2>
171
 
<title><anchor id="LU-GROUPNAME:CAPS"/>LU_GROUPNAME</title>
 
174
<title><anchor id="LU-GROUPNAME:CAPS" role="macro"/>LU_GROUPNAME</title>
172
175
<indexterm><primary>LU_GROUPNAME</primary></indexterm><programlisting>#define LU_GROUPNAME              "gr_name"
173
176
</programlisting>
174
177
<para>
175
178
 
176
179
</para></refsect2>
177
180
<refsect2>
178
 
<title><anchor id="LU-GROUPPASSWORD:CAPS"/>LU_GROUPPASSWORD</title>
 
181
<title><anchor id="LU-GROUPPASSWORD:CAPS" role="macro"/>LU_GROUPPASSWORD</title>
179
182
<indexterm><primary>LU_GROUPPASSWORD</primary></indexterm><programlisting>#define LU_GROUPPASSWORD      "gr_passwd"
180
183
</programlisting>
181
184
<para>
182
185
 
183
186
</para></refsect2>
184
187
<refsect2>
185
 
<title><anchor id="LU-MEMBERNAME:CAPS"/>LU_MEMBERNAME</title>
 
188
<title><anchor id="LU-MEMBERNAME:CAPS" role="macro"/>LU_MEMBERNAME</title>
186
189
<indexterm><primary>LU_MEMBERNAME</primary></indexterm><programlisting>#define LU_MEMBERNAME            "gr_mem"
187
190
</programlisting>
188
191
<para>
189
192
 
190
193
</para></refsect2>
191
194
<refsect2>
192
 
<title><anchor id="LU-ADMINISTRATORNAME:CAPS"/>LU_ADMINISTRATORNAME</title>
 
195
<title><anchor id="LU-ADMINISTRATORNAME:CAPS" role="macro"/>LU_ADMINISTRATORNAME</title>
193
196
<indexterm><primary>LU_ADMINISTRATORNAME</primary></indexterm><programlisting>#define LU_ADMINISTRATORNAME      "gr_adm"
194
197
</programlisting>
195
198
<para>
196
199
 
197
200
</para></refsect2>
198
201
<refsect2>
199
 
<title><anchor id="LU-SHADOWNAME:CAPS"/>LU_SHADOWNAME</title>
 
202
<title><anchor id="LU-SHADOWNAME:CAPS" role="macro"/>LU_SHADOWNAME</title>
200
203
<indexterm><primary>LU_SHADOWNAME</primary></indexterm><programlisting>#define LU_SHADOWNAME            LU_USERNAME
201
204
</programlisting>
202
205
<para>
203
206
 
204
207
</para></refsect2>
205
208
<refsect2>
206
 
<title><anchor id="LU-SHADOWPASSWORD:CAPS"/>LU_SHADOWPASSWORD</title>
 
209
<title><anchor id="LU-SHADOWPASSWORD:CAPS" role="macro"/>LU_SHADOWPASSWORD</title>
207
210
<indexterm><primary>LU_SHADOWPASSWORD</primary></indexterm><programlisting>#define LU_SHADOWPASSWORD    "sp_pwdp"
208
211
</programlisting>
209
212
<para>
210
213
 
211
214
</para></refsect2>
212
215
<refsect2>
213
 
<title><anchor id="LU-SHADOWLASTCHANGE:CAPS"/>LU_SHADOWLASTCHANGE</title>
 
216
<title><anchor id="LU-SHADOWLASTCHANGE:CAPS" role="macro"/>LU_SHADOWLASTCHANGE</title>
214
217
<indexterm><primary>LU_SHADOWLASTCHANGE</primary></indexterm><programlisting>#define LU_SHADOWLASTCHANGE        "sp_lstchg"
215
218
</programlisting>
216
219
<para>
217
220
 
218
221
</para></refsect2>
219
222
<refsect2>
220
 
<title><anchor id="LU-SHADOWMIN:CAPS"/>LU_SHADOWMIN</title>
 
223
<title><anchor id="LU-SHADOWMIN:CAPS" role="macro"/>LU_SHADOWMIN</title>
221
224
<indexterm><primary>LU_SHADOWMIN</primary></indexterm><programlisting>#define LU_SHADOWMIN              "sp_min"
222
225
</programlisting>
223
226
<para>
224
227
 
225
228
</para></refsect2>
226
229
<refsect2>
227
 
<title><anchor id="LU-SHADOWMAX:CAPS"/>LU_SHADOWMAX</title>
 
230
<title><anchor id="LU-SHADOWMAX:CAPS" role="macro"/>LU_SHADOWMAX</title>
228
231
<indexterm><primary>LU_SHADOWMAX</primary></indexterm><programlisting>#define LU_SHADOWMAX              "sp_max"
229
232
</programlisting>
230
233
<para>
231
234
 
232
235
</para></refsect2>
233
236
<refsect2>
234
 
<title><anchor id="LU-SHADOWWARNING:CAPS"/>LU_SHADOWWARNING</title>
 
237
<title><anchor id="LU-SHADOWWARNING:CAPS" role="macro"/>LU_SHADOWWARNING</title>
235
238
<indexterm><primary>LU_SHADOWWARNING</primary></indexterm><programlisting>#define LU_SHADOWWARNING      "sp_warn"
236
239
</programlisting>
237
240
<para>
238
241
 
239
242
</para></refsect2>
240
243
<refsect2>
241
 
<title><anchor id="LU-SHADOWINACTIVE:CAPS"/>LU_SHADOWINACTIVE</title>
 
244
<title><anchor id="LU-SHADOWINACTIVE:CAPS" role="macro"/>LU_SHADOWINACTIVE</title>
242
245
<indexterm><primary>LU_SHADOWINACTIVE</primary></indexterm><programlisting>#define LU_SHADOWINACTIVE    "sp_inact"
243
246
</programlisting>
244
247
<para>
245
248
 
246
249
</para></refsect2>
247
250
<refsect2>
248
 
<title><anchor id="LU-SHADOWEXPIRE:CAPS"/>LU_SHADOWEXPIRE</title>
 
251
<title><anchor id="LU-SHADOWEXPIRE:CAPS" role="macro"/>LU_SHADOWEXPIRE</title>
249
252
<indexterm><primary>LU_SHADOWEXPIRE</primary></indexterm><programlisting>#define LU_SHADOWEXPIRE                "sp_expire"
250
253
</programlisting>
251
254
<para>
252
255
 
253
256
</para></refsect2>
254
257
<refsect2>
255
 
<title><anchor id="LU-SHADOWFLAG:CAPS"/>LU_SHADOWFLAG</title>
 
258
<title><anchor id="LU-SHADOWFLAG:CAPS" role="macro"/>LU_SHADOWFLAG</title>
256
259
<indexterm><primary>LU_SHADOWFLAG</primary></indexterm><programlisting>#define LU_SHADOWFLAG            "sp_flag"
257
260
</programlisting>
258
261
<para>
259
262
 
260
263
</para></refsect2>
261
264
<refsect2>
262
 
<title><anchor id="LU-COMMONNAME:CAPS"/>LU_COMMONNAME</title>
 
265
<title><anchor id="LU-COMMONNAME:CAPS" role="macro"/>LU_COMMONNAME</title>
263
266
<indexterm><primary>LU_COMMONNAME</primary></indexterm><programlisting>#define LU_COMMONNAME            "cn"
264
267
</programlisting>
265
268
<para>
266
269
 
267
270
</para></refsect2>
268
271
<refsect2>
269
 
<title><anchor id="LU-GIVENNAME:CAPS"/>LU_GIVENNAME</title>
 
272
<title><anchor id="LU-GIVENNAME:CAPS" role="macro"/>LU_GIVENNAME</title>
270
273
<indexterm><primary>LU_GIVENNAME</primary></indexterm><programlisting>#define LU_GIVENNAME              "givenName"
271
274
</programlisting>
272
275
<para>
273
276
 
274
277
</para></refsect2>
275
278
<refsect2>
276
 
<title><anchor id="LU-SN:CAPS"/>LU_SN</title>
 
279
<title><anchor id="LU-SN:CAPS" role="macro"/>LU_SN</title>
277
280
<indexterm><primary>LU_SN</primary></indexterm><programlisting>#define LU_SN                    "sn"
278
281
</programlisting>
279
282
<para>
280
283
 
281
284
</para></refsect2>
282
285
<refsect2>
283
 
<title><anchor id="LU-ROOMNUMBER:CAPS"/>LU_ROOMNUMBER</title>
 
286
<title><anchor id="LU-ROOMNUMBER:CAPS" role="macro"/>LU_ROOMNUMBER</title>
284
287
<indexterm><primary>LU_ROOMNUMBER</primary></indexterm><programlisting>#define LU_ROOMNUMBER            "roomNumber"
285
288
</programlisting>
286
289
<para>
287
290
 
288
291
</para></refsect2>
289
292
<refsect2>
290
 
<title><anchor id="LU-TELEPHONENUMBER:CAPS"/>LU_TELEPHONENUMBER</title>
 
293
<title><anchor id="LU-TELEPHONENUMBER:CAPS" role="macro"/>LU_TELEPHONENUMBER</title>
291
294
<indexterm><primary>LU_TELEPHONENUMBER</primary></indexterm><programlisting>#define LU_TELEPHONENUMBER  "telephoneNumber"
292
295
</programlisting>
293
296
<para>
294
297
 
295
298
</para></refsect2>
296
299
<refsect2>
297
 
<title><anchor id="LU-HOMEPHONE:CAPS"/>LU_HOMEPHONE</title>
 
300
<title><anchor id="LU-HOMEPHONE:CAPS" role="macro"/>LU_HOMEPHONE</title>
298
301
<indexterm><primary>LU_HOMEPHONE</primary></indexterm><programlisting>#define LU_HOMEPHONE              "homePhone"
299
302
</programlisting>
300
303
<para>
301
304
 
302
305
</para></refsect2>
303
306
<refsect2>
304
 
<title><anchor id="LU-EMAIL:CAPS"/>LU_EMAIL</title>
 
307
<title><anchor id="LU-EMAIL:CAPS" role="macro"/>LU_EMAIL</title>
305
308
<indexterm><primary>LU_EMAIL</primary></indexterm><programlisting>#define LU_EMAIL              "mail"
306
309
</programlisting>
307
310
<para>
308
311
 
309
312
</para></refsect2>
310
313
<refsect2>
311
 
<title><anchor id="lu-ent-new"/>lu_ent_new ()</title>
 
314
<title><anchor id="lu-ent-new" role="function"/>lu_ent_new ()</title>
312
315
<indexterm><primary>lu_ent_new</primary></indexterm><programlisting><link linkend="lu-ent-t">lu_ent_t</link>*   lu_ent_new                      (void);</programlisting>
313
316
<para>
314
317
Creates a new, empty struct <link linkend="lu-ent"><type>lu_ent</type></link>.
319
322
</simpara></listitem></varlistentry>
320
323
</variablelist></refsect2>
321
324
<refsect2>
322
 
<title><anchor id="lu-ent-free"/>lu_ent_free ()</title>
 
325
<title><anchor id="lu-ent-free" role="function"/>lu_ent_free ()</title>
323
326
<indexterm><primary>lu_ent_free</primary></indexterm><programlisting><link linkend="void">void</link>        lu_ent_free                     (<link linkend="lu-ent-t">lu_ent_t</link> *ent);</programlisting>
324
327
<para>
325
328
Frees an struct <link linkend="lu-ent"><type>lu_ent</type></link>, including all strings it owns.
331
334
</simpara></listitem></varlistentry>
332
335
</variablelist></refsect2>
333
336
<refsect2>
334
 
<title><anchor id="lu-ent-copy"/>lu_ent_copy ()</title>
 
337
<title><anchor id="lu-ent-copy" role="function"/>lu_ent_copy ()</title>
335
338
<indexterm><primary>lu_ent_copy</primary></indexterm><programlisting><link linkend="void">void</link>        lu_ent_copy                     (<link linkend="lu-ent-t">lu_ent_t</link> *source,
336
339
                                             <link linkend="lu-ent-t">lu_ent_t</link> *dest);</programlisting>
337
340
<para>
347
350
</simpara></listitem></varlistentry>
348
351
</variablelist></refsect2>
349
352
<refsect2>
350
 
<title><anchor id="lu-ent-commit"/>lu_ent_commit ()</title>
 
353
<title><anchor id="lu-ent-commit" role="function"/>lu_ent_commit ()</title>
351
354
<indexterm><primary>lu_ent_commit</primary></indexterm><programlisting><link linkend="void">void</link>        lu_ent_commit                   (<link linkend="lu-ent-t">lu_ent_t</link> *ent);</programlisting>
352
355
<para>
353
356
Sets pending attribute changes as current values of the entity.
359
362
</simpara></listitem></varlistentry>
360
363
</variablelist></refsect2>
361
364
<refsect2>
362
 
<title><anchor id="lu-ent-revert"/>lu_ent_revert ()</title>
 
365
<title><anchor id="lu-ent-revert" role="function"/>lu_ent_revert ()</title>
363
366
<indexterm><primary>lu_ent_revert</primary></indexterm><programlisting><link linkend="void">void</link>        lu_ent_revert                   (<link linkend="lu-ent-t">lu_ent_t</link> *ent);</programlisting>
364
367
<para>
365
368
Replaces all attributes with changes pending by their current values,
372
375
</simpara></listitem></varlistentry>
373
376
</variablelist></refsect2>
374
377
<refsect2>
375
 
<title><anchor id="lu-ent-add"/>lu_ent_add ()</title>
 
378
<title><anchor id="lu-ent-add" role="function"/>lu_ent_add ()</title>
376
379
<indexterm><primary>lu_ent_add</primary></indexterm><programlisting><link linkend="void">void</link>        lu_ent_add                      (<link linkend="lu-ent-t">lu_ent_t</link> *ent,
377
380
                                             const <link linkend="char">char</link> *attr,
378
381
                                             const <link linkend="GValue">GValue</link> *value);</programlisting>
393
396
</simpara></listitem></varlistentry>
394
397
</variablelist></refsect2>
395
398
<refsect2>
396
 
<title><anchor id="lu-ent-add-current"/>lu_ent_add_current ()</title>
 
399
<title><anchor id="lu-ent-add-current" role="function"/>lu_ent_add_current ()</title>
397
400
<indexterm><primary>lu_ent_add_current</primary></indexterm><programlisting><link linkend="void">void</link>        lu_ent_add_current              (<link linkend="lu-ent-t">lu_ent_t</link> *ent,
398
401
                                             const <link linkend="char">char</link> *attr,
399
402
                                             const <link linkend="GValue">GValue</link> *value);</programlisting>
414
417
</simpara></listitem></varlistentry>
415
418
</variablelist></refsect2>
416
419
<refsect2>
417
 
<title><anchor id="lu-ent-clear"/>lu_ent_clear ()</title>
 
420
<title><anchor id="lu-ent-clear" role="function"/>lu_ent_clear ()</title>
418
421
<indexterm><primary>lu_ent_clear</primary></indexterm><programlisting><link linkend="void">void</link>        lu_ent_clear                    (<link linkend="lu-ent-t">lu_ent_t</link> *ent,
419
422
                                             const <link linkend="char">char</link> *attr);</programlisting>
420
423
<para>
430
433
</simpara></listitem></varlistentry>
431
434
</variablelist></refsect2>
432
435
<refsect2>
433
 
<title><anchor id="lu-ent-clear-all"/>lu_ent_clear_all ()</title>
 
436
<title><anchor id="lu-ent-clear-all" role="function"/>lu_ent_clear_all ()</title>
434
437
<indexterm><primary>lu_ent_clear_all</primary></indexterm><programlisting><link linkend="void">void</link>        lu_ent_clear_all                (<link linkend="lu-ent-t">lu_ent_t</link> *ent);</programlisting>
435
438
<para>
436
439
Removes all pending attributes from a struct <link linkend="lu-ent"><type>lu_ent</type></link>.
442
445
</simpara></listitem></varlistentry>
443
446
</variablelist></refsect2>
444
447
<refsect2>
445
 
<title><anchor id="lu-ent-clear-all-current"/>lu_ent_clear_all_current ()</title>
 
448
<title><anchor id="lu-ent-clear-all-current" role="function"/>lu_ent_clear_all_current ()</title>
446
449
<indexterm><primary>lu_ent_clear_all_current</primary></indexterm><programlisting><link linkend="void">void</link>        lu_ent_clear_all_current        (<link linkend="lu-ent-t">lu_ent_t</link> *ent);</programlisting>
447
450
<para>
448
451
Removes all current attributes from a struct <link linkend="lu-ent"><type>lu_ent</type></link>.
454
457
</simpara></listitem></varlistentry>
455
458
</variablelist></refsect2>
456
459
<refsect2>
457
 
<title><anchor id="lu-ent-clear-current"/>lu_ent_clear_current ()</title>
 
460
<title><anchor id="lu-ent-clear-current" role="function"/>lu_ent_clear_current ()</title>
458
461
<indexterm><primary>lu_ent_clear_current</primary></indexterm><programlisting><link linkend="void">void</link>        lu_ent_clear_current            (<link linkend="lu-ent-t">lu_ent_t</link> *ent,
459
462
                                             const <link linkend="char">char</link> *attr);</programlisting>
460
463
<para>
470
473
</simpara></listitem></varlistentry>
471
474
</variablelist></refsect2>
472
475
<refsect2>
473
 
<title><anchor id="lu-ent-del"/>lu_ent_del ()</title>
 
476
<title><anchor id="lu-ent-del" role="function"/>lu_ent_del ()</title>
474
477
<indexterm><primary>lu_ent_del</primary></indexterm><programlisting><link linkend="void">void</link>        lu_ent_del                      (<link linkend="lu-ent-t">lu_ent_t</link> *ent,
475
478
                                             const <link linkend="char">char</link> *attr,
476
479
                                             const <link linkend="GValue">GValue</link> *value);</programlisting>
491
494
</simpara></listitem></varlistentry>
492
495
</variablelist></refsect2>
493
496
<refsect2>
494
 
<title><anchor id="lu-ent-del-current"/>lu_ent_del_current ()</title>
 
497
<title><anchor id="lu-ent-del-current" role="function"/>lu_ent_del_current ()</title>
495
498
<indexterm><primary>lu_ent_del_current</primary></indexterm><programlisting><link linkend="void">void</link>        lu_ent_del_current              (<link linkend="lu-ent-t">lu_ent_t</link> *ent,
496
499
                                             const <link linkend="char">char</link> *attr,
497
500
                                             const <link linkend="GValue">GValue</link> *value);</programlisting>
512
515
</simpara></listitem></varlistentry>
513
516
</variablelist></refsect2>
514
517
<refsect2>
515
 
<title><anchor id="lu-ent-dump"/>lu_ent_dump ()</title>
 
518
<title><anchor id="lu-ent-dump" role="function"/>lu_ent_dump ()</title>
516
519
<indexterm><primary>lu_ent_dump</primary></indexterm><programlisting><link linkend="void">void</link>        lu_ent_dump                     (<link linkend="lu-ent-t">lu_ent_t</link> *ent,
517
520
                                             <link linkend="FILE:CAPS">FILE</link> *fp);</programlisting>
518
521
<para>
528
531
</simpara></listitem></varlistentry>
529
532
</variablelist></refsect2>
530
533
<refsect2>
531
 
<title><anchor id="lu-ent-get"/>lu_ent_get ()</title>
 
534
<title><anchor id="lu-ent-get" role="function"/>lu_ent_get ()</title>
532
535
<indexterm><primary>lu_ent_get</primary></indexterm><programlisting><link linkend="GValueArray">GValueArray</link>* lu_ent_get                     (<link linkend="lu-ent-t">lu_ent_t</link> *ent,
533
536
                                             const <link linkend="char">char</link> *attribute);</programlisting>
534
537
<para>
542
545
</simpara></listitem></varlistentry>
543
546
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>an array of values, valid at least until they are modified or
544
547
deleted. The array is never empty and it should not be freed by the caller.
545
 
Returns <literal>NULL</literal> if the attribute is not present at all or on error.
 
548
Returns <link linkend="NULL:CAPS"><literal>NULL</literal></link> if the attribute is not present at all or on error.
546
549
 
547
550
 
548
551
</simpara></listitem></varlistentry>
549
552
</variablelist></refsect2>
550
553
<refsect2>
551
 
<title><anchor id="lu-ent-get-attributes"/>lu_ent_get_attributes ()</title>
 
554
<title><anchor id="lu-ent-get-attributes" role="function"/>lu_ent_get_attributes ()</title>
552
555
<indexterm><primary>lu_ent_get_attributes</primary></indexterm><programlisting><link linkend="GList">GList</link>*      lu_ent_get_attributes           (<link linkend="lu-ent-t">lu_ent_t</link> *ent);</programlisting>
553
556
<para>
554
557
Returns a list of all pending attributes in a struct <link linkend="lu-ent"><type>lu_ent</type></link>.
563
566
</simpara></listitem></varlistentry>
564
567
</variablelist></refsect2>
565
568
<refsect2>
566
 
<title><anchor id="lu-ent-get-attributes-current"/>lu_ent_get_attributes_current ()</title>
 
569
<title><anchor id="lu-ent-get-attributes-current" role="function"/>lu_ent_get_attributes_current ()</title>
567
570
<indexterm><primary>lu_ent_get_attributes_current</primary></indexterm><programlisting><link linkend="GList">GList</link>*      lu_ent_get_attributes_current   (<link linkend="lu-ent-t">lu_ent_t</link> *ent);</programlisting>
568
571
<para>
569
572
Returns a list of all current attributes in a struct <link linkend="lu-ent"><type>lu_ent</type></link>.
578
581
</simpara></listitem></varlistentry>
579
582
</variablelist></refsect2>
580
583
<refsect2>
581
 
<title><anchor id="lu-ent-get-current"/>lu_ent_get_current ()</title>
 
584
<title><anchor id="lu-ent-get-current" role="function"/>lu_ent_get_current ()</title>
582
585
<indexterm><primary>lu_ent_get_current</primary></indexterm><programlisting><link linkend="GValueArray">GValueArray</link>* lu_ent_get_current             (<link linkend="lu-ent-t">lu_ent_t</link> *ent,
583
586
                                             const <link linkend="char">char</link> *attribute);</programlisting>
584
587
<para>
591
594
<listitem><simpara>attribute name
592
595
</simpara></listitem></varlistentry>
593
596
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>a list of values, valid at least until they are modified or deleted.
594
 
The list should not be freed by the caller.  Returns <literal>NULL</literal> if the attribute is
 
597
The list should not be freed by the caller.  Returns <link linkend="NULL:CAPS"><literal>NULL</literal></link> if the attribute is
595
598
not present at all or on error.
596
599
 
597
600
 
598
601
</simpara></listitem></varlistentry>
599
602
</variablelist></refsect2>
600
603
<refsect2>
601
 
<title><anchor id="lu-ent-has"/>lu_ent_has ()</title>
 
604
<title><anchor id="lu-ent-has" role="function"/>lu_ent_has ()</title>
602
605
<indexterm><primary>lu_ent_has</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    lu_ent_has                      (<link linkend="lu-ent-t">lu_ent_t</link> *ent,
603
606
                                             const <link linkend="char">char</link> *attribute);</programlisting>
604
607
<para>
610
613
<varlistentry><term><parameter>attribute</parameter>&nbsp;:</term>
611
614
<listitem><simpara>attribute name
612
615
</simpara></listitem></varlistentry>
613
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara><literal>TRUE</literal> if <parameter>attribute</parameter> has a value in <parameter>ent</parameter>.
 
616
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara><link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>attribute</parameter> has a value in <parameter>ent</parameter>.
614
617
 
615
618
 
616
619
</simpara></listitem></varlistentry>
617
620
</variablelist></refsect2>
618
621
<refsect2>
619
 
<title><anchor id="lu-ent-has-current"/>lu_ent_has_current ()</title>
 
622
<title><anchor id="lu-ent-has-current" role="function"/>lu_ent_has_current ()</title>
620
623
<indexterm><primary>lu_ent_has_current</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    lu_ent_has_current              (<link linkend="lu-ent-t">lu_ent_t</link> *ent,
621
624
                                             const <link linkend="char">char</link> *attribute);</programlisting>
622
625
<para>
628
631
<varlistentry><term><parameter>attribute</parameter>&nbsp;:</term>
629
632
<listitem><simpara>attribute name
630
633
</simpara></listitem></varlistentry>
631
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara><literal>TRUE</literal> if <parameter>attribute</parameter> has a value in <parameter>ent</parameter>.
 
634
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara><link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>attribute</parameter> has a value in <parameter>ent</parameter>.
632
635
 
633
636
 
634
637
</simpara></listitem></varlistentry>
635
638
</variablelist></refsect2>
636
639
<refsect2>
637
 
<title><anchor id="lu-ent-set"/>lu_ent_set ()</title>
 
640
<title><anchor id="lu-ent-set" role="function"/>lu_ent_set ()</title>
638
641
<indexterm><primary>lu_ent_set</primary></indexterm><programlisting><link linkend="void">void</link>        lu_ent_set                      (<link linkend="lu-ent-t">lu_ent_t</link> *ent,
639
642
                                             const <link linkend="char">char</link> *attr,
640
643
                                             const <link linkend="GValueArray">GValueArray</link> *values);</programlisting>
655
658
</simpara></listitem></varlistentry>
656
659
</variablelist></refsect2>
657
660
<refsect2>
658
 
<title><anchor id="lu-ent-set-current"/>lu_ent_set_current ()</title>
 
661
<title><anchor id="lu-ent-set-current" role="function"/>lu_ent_set_current ()</title>
659
662
<indexterm><primary>lu_ent_set_current</primary></indexterm><programlisting><link linkend="void">void</link>        lu_ent_set_current              (<link linkend="lu-ent-t">lu_ent_t</link> *ent,
660
663
                                             const <link linkend="char">char</link> *attr,
661
664
                                             const <link linkend="GValueArray">GValueArray</link> *values);</programlisting>