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
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>C-Layman: Layman API</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.8 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>Layman API</h1>Main API functions.
<a href="#_details">More...</a>
<p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__layman__api.html#gc1ae8bdf47eca0cea7bb8e7f3147cded">laymanAPICreate</a> (<a class="el" href="struct_bare_config.html">BareConfig</a> *config, int report_error, int output)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__layman__api.html#g565dbbf32dcbaa175bb9d3038c079725">laymanAPIIsRepo</a> (<a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> *l, const char *repo)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__layman__api.html#g9cc093b2c4e423cd16c2b0fb9b5ef3c6">laymanAPIIsInstalled</a> (<a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> *l, const char *repo)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct_string_list.html">StringList</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__layman__api.html#gb5def5ffed71eadc0b49a826905c30e4">laymanAPIGetAvailable</a> (<a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> *l, int reload)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct_string_list.html">StringList</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__layman__api.html#g87060319cb5448e8776f5b2b960c12eb">laymanAPIGetInstalled</a> (<a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> *l, int reload)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__layman__api.html#g23f91e7730d5cdd000a53debc6854b10">laymanAPISync</a> (<a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> *l, const char *overlay, int verbose)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__layman__api.html#g8fbe3095011d998bf0bfe8aab46f2009">laymanAPIFetchRemoteList</a> (<a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> *l)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__layman__api.html#gcdc26d10e9faf847996c3ae3295c48b7">laymanAPIGetInfoStrList</a> (<a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> *l, <a class="el" href="struct_string_list.html">StringList</a> *overlays, <a class="el" href="struct_overlay_info.html">OverlayInfo</a> *results)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct_overlay_info.html">OverlayInfo</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__layman__api.html#ge97d530a816f7da28be35eb20a8ab22d">laymanAPIGetInfoStr</a> (<a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> *l, const char *overlay)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="struct_overlay_info.html">OverlayInfo</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__layman__api.html#gf5e1d733f389f845e594c25b99706415">laymanAPIGetAllInfo</a> (<a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> *l, const char *overlay)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__layman__api.html#g2e04f8103171790be61f092078fea8ff">laymanAPIGetAllInfoList</a> (<a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> *l, <a class="el" href="struct_string_list.html">StringList</a> *overlays, <a class="el" href="struct_overlay_info.html">OverlayInfo</a> *results)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__layman__api.html#g8ea2f5e93d017bd0ac40a745d4dc2219">laymanAPIAddRepo</a> (<a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> *l, const char *repo)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__layman__api.html#gb090e78aaf388d85ea79db19991c5e65">laymanAPIAddRepoList</a> (<a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> *l, <a class="el" href="struct_string_list.html">StringList</a> *repos)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__layman__api.html#ge5227c228a1c4a2a18a674bca298c331">laymanAPIDeleteRepo</a> (<a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> *l, const char *repo)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__layman__api.html#g0cd008dbdec709f24a3b88fefdfe3796">laymanAPIDeleteRepoList</a> (<a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> *l, <a class="el" href="struct_string_list.html">StringList</a> *repos)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__layman__api.html#g9babe72a16d6fd80b9f138ca6fb7a379">laymanAPIFree</a> (<a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> *l)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__layman__api.html#gc9e16e85ef3f86b8f325dcb63e30403f">overlayInfoFree</a> (<a class="el" href="struct_overlay_info.html">OverlayInfo</a> oi)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Main API functions. <hr><h2>Function Documentation</h2>
<a class="anchor" name="g8ea2f5e93d017bd0ac40a745d4dc2219"></a><!-- doxytag: member="laymanapi.c::laymanAPIAddRepo" ref="g8ea2f5e93d017bd0ac40a745d4dc2219" args="(LaymanAPI *l, const char *repo)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int laymanAPIAddRepo </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> * </td>
<td class="paramname"> <em>l</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>repo</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Adds an overlay to layman<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>repo</em> </td><td>the name of the repository to add</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if it succeeded, False if not </dd></dl>
</div>
</div><p>
<a class="anchor" name="gb090e78aaf388d85ea79db19991c5e65"></a><!-- doxytag: member="laymanapi.c::laymanAPIAddRepoList" ref="gb090e78aaf388d85ea79db19991c5e65" args="(LaymanAPI *l, StringList *repos)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int laymanAPIAddRepoList </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> * </td>
<td class="paramname"> <em>l</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_string_list.html">StringList</a> * </td>
<td class="paramname"> <em>repos</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Adds a list of overlays to layman<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>repo</em> </td><td>the list of the repositories to add</td></tr>
</table>
</dl>
Return True if it succeeded, False if not
</div>
</div><p>
<a class="anchor" name="gc1ae8bdf47eca0cea7bb8e7f3147cded"></a><!-- doxytag: member="laymanapi.c::laymanAPICreate" ref="gc1ae8bdf47eca0cea7bb8e7f3147cded" args="(BareConfig *config, int report_error, int output)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a>* laymanAPICreate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_bare_config.html">BareConfig</a> * </td>
<td class="paramname"> <em>config</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>report_error</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>output</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Creates a <a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> object that must be used in all function in this file.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>config</em> </td><td>a <a class="el" href="struct_bare_config.html">BareConfig</a> object that contains all configuration options. If NULL, the default configuration will be used. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>report_error</em> </td><td>if True, errors reporting on stdout will be activated. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>output</em> </td><td>? </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>a new instance of the <a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> class, to be freed with <a class="el" href="group__layman__api.html#g9babe72a16d6fd80b9f138ca6fb7a379">laymanAPIFree()</a> </dd></dl>
</div>
</div><p>
<a class="anchor" name="ge5227c228a1c4a2a18a674bca298c331"></a><!-- doxytag: member="laymanapi.c::laymanAPIDeleteRepo" ref="ge5227c228a1c4a2a18a674bca298c331" args="(LaymanAPI *l, const char *repo)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int laymanAPIDeleteRepo </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> * </td>
<td class="paramname"> <em>l</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>repo</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Deletes an overlay from layman<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>repo</em> </td><td>the name of the repository to delete</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if it succeeded, False if not </dd></dl>
</div>
</div><p>
<a class="anchor" name="g0cd008dbdec709f24a3b88fefdfe3796"></a><!-- doxytag: member="laymanapi.c::laymanAPIDeleteRepoList" ref="g0cd008dbdec709f24a3b88fefdfe3796" args="(LaymanAPI *l, StringList *repos)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int laymanAPIDeleteRepoList </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> * </td>
<td class="paramname"> <em>l</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_string_list.html">StringList</a> * </td>
<td class="paramname"> <em>repos</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Deletes a list of overlays from layman<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>repo</em> </td><td>the list of the repositories to delete</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if it succeeded, False if not </dd></dl>
</div>
</div><p>
<a class="anchor" name="g8fbe3095011d998bf0bfe8aab46f2009"></a><!-- doxytag: member="laymanapi.c::laymanAPIFetchRemoteList" ref="g8fbe3095011d998bf0bfe8aab46f2009" args="(LaymanAPI *l)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int laymanAPIFetchRemoteList </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> * </td>
<td class="paramname"> <em>l</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Updates the local overlay list.<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if it succeeded, False if not. </dd></dl>
</div>
</div><p>
<a class="anchor" name="g9babe72a16d6fd80b9f138ca6fb7a379"></a><!-- doxytag: member="laymanapi.c::laymanAPIFree" ref="g9babe72a16d6fd80b9f138ca6fb7a379" args="(LaymanAPI *l)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void laymanAPIFree </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> * </td>
<td class="paramname"> <em>l</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Frees a <a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> object from memory
</div>
</div><p>
<a class="anchor" name="gf5e1d733f389f845e594c25b99706415"></a><!-- doxytag: member="laymanapi.c::laymanAPIGetAllInfo" ref="gf5e1d733f389f845e594c25b99706415" args="(LaymanAPI *l, const char *overlay)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_overlay_info.html">OverlayInfo</a>* laymanAPIGetAllInfo </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> * </td>
<td class="paramname"> <em>l</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>overlay</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get all information from an overlay. This function fills every fields but the text field of the <a class="el" href="struct_overlay_info.html">OverlayInfo</a> structure.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>overlay</em> </td><td>the overlay name to get info from</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>NULL if it fails, an <a class="el" href="struct_overlay_info.html">OverlayInfo</a> struct if not. </dd></dl>
</div>
</div><p>
<a class="anchor" name="g2e04f8103171790be61f092078fea8ff"></a><!-- doxytag: member="laymanapi.c::laymanAPIGetAllInfoList" ref="g2e04f8103171790be61f092078fea8ff" args="(LaymanAPI *l, StringList *overlays, OverlayInfo *results)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int laymanAPIGetAllInfoList </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> * </td>
<td class="paramname"> <em>l</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_string_list.html">StringList</a> * </td>
<td class="paramname"> <em>overlays</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_overlay_info.html">OverlayInfo</a> * </td>
<td class="paramname"> <em>results</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gives a list of OverlayInfo's from the overaly names found in the overlays <a class="el" href="struct_string_list.html">StringList</a>. results must be allocated and initialized with zeroes.<p>
If an information is unavailable (no owner email for example), the correpsonding field will stay to NULL<p>
This function fills every fields but the text field of the <a class="el" href="struct_overlay_info.html">OverlayInfo</a> structure.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>overlays</em> </td><td>the list of overlays to get information from </td></tr>
<tr><td valign="top"></td><td valign="top"><em>results</em> </td><td>a pointer to a table of <a class="el" href="struct_overlay_info.html">OverlayInfo</a> structures</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the number of <a class="el" href="struct_overlay_info.html">OverlayInfo</a> structures filled. </dd></dl>
</div>
</div><p>
<a class="anchor" name="gb5def5ffed71eadc0b49a826905c30e4"></a><!-- doxytag: member="laymanapi.c::laymanAPIGetAvailable" ref="gb5def5ffed71eadc0b49a826905c30e4" args="(LaymanAPI *l, int reload)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_string_list.html">StringList</a>* laymanAPIGetAvailable </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> * </td>
<td class="paramname"> <em>l</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>reload</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns a list of the available overlays.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>l</em> </td><td>the <a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>reload</em> </td><td>if True, reloads the list</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the list of available overlays </dd></dl>
</div>
</div><p>
<a class="anchor" name="ge97d530a816f7da28be35eb20a8ab22d"></a><!-- doxytag: member="laymanapi.c::laymanAPIGetInfoStr" ref="ge97d530a816f7da28be35eb20a8ab22d" args="(LaymanAPI *l, const char *overlay)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_overlay_info.html">OverlayInfo</a>* laymanAPIGetInfoStr </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> * </td>
<td class="paramname"> <em>l</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>overlay</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Provided for convenience, this function get the information for only 1 overlay.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>overlay</em> </td><td>the overlay name to get info from</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>NULL if it fails, an <a class="el" href="struct_overlay_info.html">OverlayInfo</a> struct if not. </dd></dl>
</div>
</div><p>
<a class="anchor" name="gcdc26d10e9faf847996c3ae3295c48b7"></a><!-- doxytag: member="laymanapi.c::laymanAPIGetInfoStrList" ref="gcdc26d10e9faf847996c3ae3295c48b7" args="(LaymanAPI *l, StringList *overlays, OverlayInfo *results)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int laymanAPIGetInfoStrList </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> * </td>
<td class="paramname"> <em>l</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_string_list.html">StringList</a> * </td>
<td class="paramname"> <em>overlays</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="struct_overlay_info.html">OverlayInfo</a> * </td>
<td class="paramname"> <em>results</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets the information from the overlays given in the <a class="el" href="struct_string_list.html">StringList</a> overlays. The results are stored in the results table which must be initialized with N structures, N being the number of overlays in the overlays <a class="el" href="struct_string_list.html">StringList</a>. This function fills the name, text, supported and official fields of the <a class="el" href="struct_overlay_info.html">OverlayInfo</a> structure.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>overlays</em> </td><td>the list of overlays to get information from </td></tr>
<tr><td valign="top"></td><td valign="top"><em>results</em> </td><td>a pointer to a table of <a class="el" href="struct_overlay_info.html">OverlayInfo</a> structures</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the number of results structures that have been filled </dd></dl>
</div>
</div><p>
<a class="anchor" name="g87060319cb5448e8776f5b2b960c12eb"></a><!-- doxytag: member="laymanapi.c::laymanAPIGetInstalled" ref="g87060319cb5448e8776f5b2b960c12eb" args="(LaymanAPI *l, int reload)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="struct_string_list.html">StringList</a>* laymanAPIGetInstalled </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> * </td>
<td class="paramname"> <em>l</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>reload</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns a list of the installed overlays.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>l</em> </td><td>the <a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>reload</em> </td><td>if True, reloads the list</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>the list of installed overlays </dd></dl>
</div>
</div><p>
<a class="anchor" name="g9cc093b2c4e423cd16c2b0fb9b5ef3c6"></a><!-- doxytag: member="laymanapi.c::laymanAPIIsInstalled" ref="g9cc093b2c4e423cd16c2b0fb9b5ef3c6" args="(LaymanAPI *l, const char *repo)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int laymanAPIIsInstalled </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> * </td>
<td class="paramname"> <em>l</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>repo</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if the given string is a valid and installed repository<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>l</em> </td><td>the <a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>repo</em> </td><td>the repository to be checked.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the repository is valid and installed, False if not </dd></dl>
</div>
</div><p>
<a class="anchor" name="g565dbbf32dcbaa175bb9d3038c079725"></a><!-- doxytag: member="laymanapi.c::laymanAPIIsRepo" ref="g565dbbf32dcbaa175bb9d3038c079725" args="(LaymanAPI *l, const char *repo)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int laymanAPIIsRepo </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> * </td>
<td class="paramname"> <em>l</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>repo</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Check if the given string is a valid repository<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>l</em> </td><td>the <a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>repo</em> </td><td>the repository to be checked.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if the repository is valid, False if not </dd></dl>
</div>
</div><p>
<a class="anchor" name="g23f91e7730d5cdd000a53debc6854b10"></a><!-- doxytag: member="laymanapi.c::laymanAPISync" ref="g23f91e7730d5cdd000a53debc6854b10" args="(LaymanAPI *l, const char *overlay, int verbose)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int laymanAPISync </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_layman_a_p_i.html">LaymanAPI</a> * </td>
<td class="paramname"> <em>l</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>overlay</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>verbose</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Syncs an overlay.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>overlay</em> </td><td>The name of the overlay to sync </td></tr>
<tr><td valign="top"></td><td valign="top"><em>verbose</em> </td><td>if True, the output will be more verbose.</td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>True if it succeeded, False if not. </dd></dl>
</div>
</div><p>
<a class="anchor" name="gc9e16e85ef3f86b8f325dcb63e30403f"></a><!-- doxytag: member="laymanapi.c::overlayInfoFree" ref="gc9e16e85ef3f86b8f325dcb63e30403f" args="(OverlayInfo oi)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void overlayInfoFree </td>
<td>(</td>
<td class="paramtype"><a class="el" href="struct_overlay_info.html">OverlayInfo</a> </td>
<td class="paramname"> <em>oi</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Aug 6 20:00:53 2010 for C-Layman by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
</body>
</html>
|
