This file is indexed.

/usr/share/gtk-doc/html/ctpl/ctpl-CtplEnviron.html is in libctpl-doc 0.3.3.dfsg-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  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>CtplEnviron</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="CTPL Reference Manual">
<link rel="up" href="ch02.html" title="API reference">
<link rel="prev" href="ctpl-CtplValue.html" title="CtplValue">
<link rel="next" href="ctpl-CtplToken.html" title="CtplToken">
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="ctpl-CtplValue.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">CTPL Reference Manual</th>
<td><a accesskey="n" href="ctpl-CtplToken.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#ctpl-CtplEnviron.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#ctpl-CtplEnviron.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="ctpl-CtplEnviron"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="ctpl-CtplEnviron.top_of_page"></a>CtplEnviron</span></h2>
<p>CtplEnviron — Environment</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="ctpl-CtplEnviron.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;ctpl/ctpl.h&gt;

#define             <a class="link" href="ctpl-CtplEnviron.html#CTPL-ENVIRON-ERROR:CAPS" title="CTPL_ENVIRON_ERROR">CTPL_ENVIRON_ERROR</a>
enum                <a class="link" href="ctpl-CtplEnviron.html#CtplEnvironError" title="enum CtplEnvironError">CtplEnvironError</a>;
                    <a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron">CtplEnviron</a>;
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            (<a class="link" href="ctpl-CtplEnviron.html#CtplEnvironForeachFunc" title="CtplEnvironForeachFunc ()">*CtplEnvironForeachFunc</a>)           (<em class="parameter"><code><a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a> *env</code></em>,
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *symbol</code></em>,
                                                         <em class="parameter"><code>const <a class="link" href="ctpl-CtplValue.html#CtplValue" title="struct CtplValue"><span class="type">CtplValue</span></a> *value</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
<a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="returnvalue">CtplEnviron</span></a> *       <a class="link" href="ctpl-CtplEnviron.html#ctpl-environ-new" title="ctpl_environ_new ()">ctpl_environ_new</a>                    (<em class="parameter"><code><span class="type">void</span></code></em>);
<a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="returnvalue">CtplEnviron</span></a> *       <a class="link" href="ctpl-CtplEnviron.html#ctpl-environ-ref" title="ctpl_environ_ref ()">ctpl_environ_ref</a>                    (<em class="parameter"><code><a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a> *env</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="ctpl-CtplEnviron.html#ctpl-environ-unref" title="ctpl_environ_unref ()">ctpl_environ_unref</a>                  (<em class="parameter"><code><a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a> *env</code></em>);
const <a class="link" href="ctpl-CtplValue.html#CtplValue" title="struct CtplValue"><span class="returnvalue">CtplValue</span></a> *   <a class="link" href="ctpl-CtplEnviron.html#ctpl-environ-lookup" title="ctpl_environ_lookup ()">ctpl_environ_lookup</a>                 (<em class="parameter"><code>const <a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a> *env</code></em>,
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *symbol</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="ctpl-CtplEnviron.html#ctpl-environ-push" title="ctpl_environ_push ()">ctpl_environ_push</a>                   (<em class="parameter"><code><a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a> *env</code></em>,
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *symbol</code></em>,
                                                         <em class="parameter"><code>const <a class="link" href="ctpl-CtplValue.html#CtplValue" title="struct CtplValue"><span class="type">CtplValue</span></a> *value</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="ctpl-CtplEnviron.html#ctpl-environ-push-int" title="ctpl_environ_push_int ()">ctpl_environ_push_int</a>               (<em class="parameter"><code><a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a> *env</code></em>,
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *symbol</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#glong"><span class="type">glong</span></a> value</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="ctpl-CtplEnviron.html#ctpl-environ-push-float" title="ctpl_environ_push_float ()">ctpl_environ_push_float</a>             (<em class="parameter"><code><a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a> *env</code></em>,
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *symbol</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> value</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="ctpl-CtplEnviron.html#ctpl-environ-push-string" title="ctpl_environ_push_string ()">ctpl_environ_push_string</a>            (<em class="parameter"><code><a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a> *env</code></em>,
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *symbol</code></em>,
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *value</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="ctpl-CtplEnviron.html#ctpl-environ-pop" title="ctpl_environ_pop ()">ctpl_environ_pop</a>                    (<em class="parameter"><code><a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a> *env</code></em>,
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *symbol</code></em>,
                                                         <em class="parameter"><code><a class="link" href="ctpl-CtplValue.html#CtplValue" title="struct CtplValue"><span class="type">CtplValue</span></a> **poped_value</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="ctpl-CtplEnviron.html#ctpl-environ-foreach" title="ctpl_environ_foreach ()">ctpl_environ_foreach</a>                (<em class="parameter"><code><a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a> *env</code></em>,
                                                         <em class="parameter"><code><a class="link" href="ctpl-CtplEnviron.html#CtplEnvironForeachFunc" title="CtplEnvironForeachFunc ()"><span class="type">CtplEnvironForeachFunc</span></a> func</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="ctpl-CtplEnviron.html#ctpl-environ-merge" title="ctpl_environ_merge ()">ctpl_environ_merge</a>                  (<em class="parameter"><code><a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a> *env</code></em>,
                                                         <em class="parameter"><code>const <a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a> *source</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> merge_symbols</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="ctpl-CtplEnviron.html#ctpl-environ-add-from-stream" title="ctpl_environ_add_from_stream ()">ctpl_environ_add_from_stream</a>        (<em class="parameter"><code><a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a> *env</code></em>,
                                                         <em class="parameter"><code><a class="link" href="ctpl-CtplInputStream.html#CtplInputStream" title="CtplInputStream"><span class="type">CtplInputStream</span></a> *stream</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="ctpl-CtplEnviron.html#ctpl-environ-add-from-path" title="ctpl_environ_add_from_path ()">ctpl_environ_add_from_path</a>          (<em class="parameter"><code><a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a> *env</code></em>,
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            <a class="link" href="ctpl-CtplEnviron.html#ctpl-environ-add-from-string" title="ctpl_environ_add_from_string ()">ctpl_environ_add_from_string</a>        (<em class="parameter"><code><a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a> *env</code></em>,
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *string</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="ctpl-CtplEnviron.description"></a><h2>Description</h2>
<p>
A <a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a> represents an environment of symbols used to lookup, push and
pop symbols when computing a template.
</p>
<p>
Use <a class="link" href="ctpl-CtplEnviron.html#ctpl-environ-new" title="ctpl_environ_new ()"><code class="function">ctpl_environ_new()</code></a> to create a new environment; and then
<a class="link" href="ctpl-CtplEnviron.html#ctpl-environ-push" title="ctpl_environ_push ()"><code class="function">ctpl_environ_push()</code></a>, <a class="link" href="ctpl-CtplEnviron.html#ctpl-environ-push-int" title="ctpl_environ_push_int ()"><code class="function">ctpl_environ_push_int()</code></a>, <a class="link" href="ctpl-CtplEnviron.html#ctpl-environ-push-float" title="ctpl_environ_push_float ()"><code class="function">ctpl_environ_push_float()</code></a> and
<a class="link" href="ctpl-CtplEnviron.html#ctpl-environ-push-string" title="ctpl_environ_push_string ()"><code class="function">ctpl_environ_push_string()</code></a> to fill it.
</p>
<p>
<a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a> uses a <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a>-style refcounting, via
<a class="link" href="ctpl-CtplEnviron.html#ctpl-environ-ref" title="ctpl_environ_ref ()"><code class="function">ctpl_environ_ref()</code></a> and <a class="link" href="ctpl-CtplEnviron.html#ctpl-environ-unref" title="ctpl_environ_unref ()"><code class="function">ctpl_environ_unref()</code></a>.
</p>
<p>
</p>
<div class="example">
<a name="idp8740000"></a><p class="title"><b>Example 10. Creating and filling a environment</b></p>
<div class="example-contents">
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
    <tbody>
      <tr>
        <td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8
9</pre></td>
        <td class="listing_code"><pre class="programlisting">CtplEnviron <span class="gtkdoc opt">*</span>env<span class="gtkdoc opt">;</span>

env <span class="gtkdoc opt">=</span> <span class="function"><a href="ctpl-CtplEnviron.html#ctpl-environ-new">ctpl_environ_new</a></span> <span class="gtkdoc opt">()</span>
<span class="function"><a href="ctpl-CtplEnviron.html#ctpl-environ-push-string">ctpl_environ_push_string</a></span> <span class="gtkdoc opt">(</span>env<span class="gtkdoc opt">,</span> <span class="string">&quot;symbol name&quot;</span><span class="gtkdoc opt">,</span> <span class="string">&quot;symbol value&quot;</span><span class="gtkdoc opt">);</span>
<span class="function"><a href="ctpl-CtplEnviron.html#ctpl-environ-push-int">ctpl_environ_push_int</a></span> <span class="gtkdoc opt">(</span>env<span class="gtkdoc opt">,</span> <span class="string">&quot;response&quot;</span><span class="gtkdoc opt">,</span> <span class="number">42</span><span class="gtkdoc opt">);</span>

<span class="comment">/* ... */</span>

<span class="function"><a href="ctpl-CtplEnviron.html#ctpl-environ-unref">ctpl_environ_unref</a></span> <span class="gtkdoc opt">(</span>env<span class="gtkdoc opt">);</span></pre></td>
      </tr>
    </tbody>
  </table>
</div>

</div>
<p><br class="example-break">
</p>
<p>
Environments can also be loaded from <a class="link" href="ctpl-CtplInputStream.html#CtplInputStream" title="CtplInputStream"><span class="type">CtplInputStream</span></a>s, strings or
files using <a class="link" href="ctpl-CtplEnviron.html#ctpl-environ-add-from-stream" title="ctpl_environ_add_from_stream ()"><code class="function">ctpl_environ_add_from_stream()</code></a>, <a class="link" href="ctpl-CtplEnviron.html#ctpl-environ-add-from-string" title="ctpl_environ_add_from_string ()"><code class="function">ctpl_environ_add_from_string()</code></a> or
<a class="link" href="ctpl-CtplEnviron.html#ctpl-environ-add-from-path" title="ctpl_environ_add_from_path ()"><code class="function">ctpl_environ_add_from_path()</code></a>. Environment descriptions are of the form
<code class="code">SYMBOL = VALUE;</code> and can contain comments. Comments start with a
<code class="code">#</code> (number sign) and end at the next line ending.
</p>
<p>
For more details, see the
<a class="link" href="environment-description-syntax.html" title="Environment description syntax">environment description
syntax</a>.
</p>
</div>
<div class="refsect1">
<a name="ctpl-CtplEnviron.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="CTPL-ENVIRON-ERROR:CAPS"></a><h3>CTPL_ENVIRON_ERROR</h3>
<pre class="programlisting">#define CTPL_ENVIRON_ERROR  (ctpl_environ_error_quark ())
</pre>
<p>
Error domain of CtplEnviron.
</p>
</div>
<hr>
<div class="refsect2">
<a name="CtplEnvironError"></a><h3>enum CtplEnvironError</h3>
<pre class="programlisting">typedef enum _CtplEnvironError
{
  CTPL_ENVIRON_ERROR_LOADER_MISSING_SYMBOL,
  CTPL_ENVIRON_ERROR_LOADER_MISSING_VALUE,
  CTPL_ENVIRON_ERROR_LOADER_MISSING_SEPARATOR,
  CTPL_ENVIRON_ERROR_FAILED
} CtplEnvironError;
</pre>
<p>
Errors in the <a class="link" href="ctpl-CtplEnviron.html#CTPL-ENVIRON-ERROR:CAPS" title="CTPL_ENVIRON_ERROR"><code class="literal">CTPL_ENVIRON_ERROR</code></a> domain.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><a name="CTPL-ENVIRON-ERROR-LOADER-MISSING-SYMBOL:CAPS"></a><span class="term"><code class="literal">CTPL_ENVIRON_ERROR_LOADER_MISSING_SYMBOL</code></span></p></td>
<td>Missing symbol in environment
                                               description
</td>
</tr>
<tr>
<td><p><a name="CTPL-ENVIRON-ERROR-LOADER-MISSING-VALUE:CAPS"></a><span class="term"><code class="literal">CTPL_ENVIRON_ERROR_LOADER_MISSING_VALUE</code></span></p></td>
<td>Missing value in environment
                                               description
</td>
</tr>
<tr>
<td><p><a name="CTPL-ENVIRON-ERROR-LOADER-MISSING-SEPARATOR:CAPS"></a><span class="term"><code class="literal">CTPL_ENVIRON_ERROR_LOADER_MISSING_SEPARATOR</code></span></p></td>
<td>Missing separator in
                                               environment description
</td>
</tr>
<tr>
<td><p><a name="CTPL-ENVIRON-ERROR-FAILED:CAPS"></a><span class="term"><code class="literal">CTPL_ENVIRON_ERROR_FAILED</code></span></p></td>
<td>An error occurred
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="CtplEnviron"></a><h3>CtplEnviron</h3>
<pre class="programlisting">typedef struct _CtplEnviron CtplEnviron;</pre>
<p>
Represents an environment.
</p>
</div>
<hr>
<div class="refsect2">
<a name="CtplEnvironForeachFunc"></a><h3>CtplEnvironForeachFunc ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            (*CtplEnvironForeachFunc)           (<em class="parameter"><code><a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a> *env</code></em>,
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *symbol</code></em>,
                                                         <em class="parameter"><code>const <a class="link" href="ctpl-CtplValue.html#CtplValue" title="struct CtplValue"><span class="type">CtplValue</span></a> *value</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>
User function for <a class="link" href="ctpl-CtplEnviron.html#ctpl-environ-foreach" title="ctpl_environ_foreach ()"><code class="function">ctpl_environ_foreach()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>env</code></em> :</span></p></td>
<td>The <a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a> on which the function was called</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>symbol</code></em> :</span></p></td>
<td>The current symbol</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>The symbol's value</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>User data passed to <a class="link" href="ctpl-CtplEnviron.html#ctpl-environ-foreach" title="ctpl_environ_foreach ()"><code class="function">ctpl_environ_foreach()</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> to continue enumerating environ, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> to stop.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ctpl-environ-new"></a><h3>ctpl_environ_new ()</h3>
<pre class="programlisting"><a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="returnvalue">CtplEnviron</span></a> *       ctpl_environ_new                    (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Creates a new <a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A new <a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ctpl-environ-ref"></a><h3>ctpl_environ_ref ()</h3>
<pre class="programlisting"><a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="returnvalue">CtplEnviron</span></a> *       ctpl_environ_ref                    (<em class="parameter"><code><a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a> *env</code></em>);</pre>
<p>
Adds a reference to a <a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>env</code></em> :</span></p></td>
<td>a <a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The environ</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.3</p>
</div>
<hr>
<div class="refsect2">
<a name="ctpl-environ-unref"></a><h3>ctpl_environ_unref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                ctpl_environ_unref                  (<em class="parameter"><code><a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a> *env</code></em>);</pre>
<p>
Removes a reference from a <a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a>. If the reference count drops to 0,
frees the environ and all its allocated resources.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>env</code></em> :</span></p></td>
<td>a <a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a>
</td>
</tr></tbody>
</table></div>
<p class="since">Since 0.3</p>
</div>
<hr>
<div class="refsect2">
<a name="ctpl-environ-lookup"></a><h3>ctpl_environ_lookup ()</h3>
<pre class="programlisting">const <a class="link" href="ctpl-CtplValue.html#CtplValue" title="struct CtplValue"><span class="returnvalue">CtplValue</span></a> *   ctpl_environ_lookup                 (<em class="parameter"><code>const <a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a> *env</code></em>,
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *symbol</code></em>);</pre>
<p>
Looks up for a symbol in the given <a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>env</code></em> :</span></p></td>
<td>A <a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>symbol</code></em> :</span></p></td>
<td>A symbol name</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>The <a class="link" href="ctpl-CtplValue.html#CtplValue" title="struct CtplValue"><span class="type">CtplValue</span></a> holding the symbol's value, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if the symbol
can't be found. This value should not be modified or freed.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ctpl-environ-push"></a><h3>ctpl_environ_push ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                ctpl_environ_push                   (<em class="parameter"><code><a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a> *env</code></em>,
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *symbol</code></em>,
                                                         <em class="parameter"><code>const <a class="link" href="ctpl-CtplValue.html#CtplValue" title="struct CtplValue"><span class="type">CtplValue</span></a> *value</code></em>);</pre>
<p>
Pushes a symbol into a <a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a>.
Pushing a symbol adds it or overwrites the value in place for it while
keeping any already present value for latter poping.
The push/pop concept is simple as a stack: when you push, you add a value on
the top of a stack, and when you pop, you remove the top element of this
stack, revealing the previous value.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>env</code></em> :</span></p></td>
<td>A <a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>symbol</code></em> :</span></p></td>
<td>The symbol name</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>The symbol value</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ctpl-environ-push-int"></a><h3>ctpl_environ_push_int ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                ctpl_environ_push_int               (<em class="parameter"><code><a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a> *env</code></em>,
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *symbol</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#glong"><span class="type">glong</span></a> value</code></em>);</pre>
<p>
Pushes an integer symbol into a <a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a>. See <a class="link" href="ctpl-CtplEnviron.html#ctpl-environ-push" title="ctpl_environ_push ()"><code class="function">ctpl_environ_push()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>env</code></em> :</span></p></td>
<td>A <a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>symbol</code></em> :</span></p></td>
<td>A symbol name</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>The symbol value</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ctpl-environ-push-float"></a><h3>ctpl_environ_push_float ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                ctpl_environ_push_float             (<em class="parameter"><code><a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a> *env</code></em>,
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *symbol</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a> value</code></em>);</pre>
<p>
Pushes a float symbol into a <a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a>. See <a class="link" href="ctpl-CtplEnviron.html#ctpl-environ-push" title="ctpl_environ_push ()"><code class="function">ctpl_environ_push()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>env</code></em> :</span></p></td>
<td>A <a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>symbol</code></em> :</span></p></td>
<td>A symbol name</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>The symbol value</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ctpl-environ-push-string"></a><h3>ctpl_environ_push_string ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                ctpl_environ_push_string            (<em class="parameter"><code><a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a> *env</code></em>,
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *symbol</code></em>,
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *value</code></em>);</pre>
<p>
Pushes a string symbol into a <a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a>. See <a class="link" href="ctpl-CtplEnviron.html#ctpl-environ-push" title="ctpl_environ_push ()"><code class="function">ctpl_environ_push()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>env</code></em> :</span></p></td>
<td>A <a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>symbol</code></em> :</span></p></td>
<td>A symbol name</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>The symbol value</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ctpl-environ-pop"></a><h3>ctpl_environ_pop ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            ctpl_environ_pop                    (<em class="parameter"><code><a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a> *env</code></em>,
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *symbol</code></em>,
                                                         <em class="parameter"><code><a class="link" href="ctpl-CtplValue.html#CtplValue" title="struct CtplValue"><span class="type">CtplValue</span></a> **poped_value</code></em>);</pre>
<p>
Tries to pop a symbol from a <a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a>. See <a class="link" href="ctpl-CtplEnviron.html#ctpl-environ-push" title="ctpl_environ_push ()"><code class="function">ctpl_environ_push()</code></a> for
details on pushing and poping.
Use <a class="link" href="ctpl-CtplEnviron.html#ctpl-environ-lookup" title="ctpl_environ_lookup ()"><code class="function">ctpl_environ_lookup()</code></a> if you want to get the symbol's value without
poping it from the environ.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>env</code></em> :</span></p></td>
<td>A <a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>symbol</code></em> :</span></p></td>
<td>A symbol name</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>poped_value</code></em> :</span></p></td>
<td>Return location for the poped value, or
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. You must free this value with <a class="link" href="ctpl-CtplValue.html#ctpl-value-free" title="ctpl_value_free ()"><code class="function">ctpl_value_free()</code></a> when you
no longer need it. This is set only if poping succeeded, so if
this function returned <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>Whether a value has been poped.</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.3</p>
</div>
<hr>
<div class="refsect2">
<a name="ctpl-environ-foreach"></a><h3>ctpl_environ_foreach ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                ctpl_environ_foreach                (<em class="parameter"><code><a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a> *env</code></em>,
                                                         <em class="parameter"><code><a class="link" href="ctpl-CtplEnviron.html#CtplEnvironForeachFunc" title="CtplEnvironForeachFunc ()"><span class="type">CtplEnvironForeachFunc</span></a> func</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>
Calls <em class="parameter"><code>func</code></em> on each symbol of the environment.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>env</code></em> :</span></p></td>
<td>A <a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
<td>A <a class="link" href="ctpl-CtplEnviron.html#CtplEnvironForeachFunc" title="CtplEnvironForeachFunc ()"><span class="type">CtplEnvironForeachFunc</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
<td>user data to pass to <em class="parameter"><code>func</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ctpl-environ-merge"></a><h3>ctpl_environ_merge ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                ctpl_environ_merge                  (<em class="parameter"><code><a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a> *env</code></em>,
                                                         <em class="parameter"><code>const <a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a> *source</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> merge_symbols</code></em>);</pre>
<p>
Merges an environment into another. If a symbol of the source environ already
exists in the destination one, its value is either pushed if <em class="parameter"><code>merge_symbols</code></em>
is true or ignored if <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>.
</p>
<p>
</p>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
  Currently, symbol merging only pushes the topmost value from the source
  environ rather than pushing it entirely.
</div>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>env</code></em> :</span></p></td>
<td>A <a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
<td>Source environ to merge with <em class="parameter"><code>env</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>merge_symbols</code></em> :</span></p></td>
<td>Whether to merge symbols that exists in both environs</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ctpl-environ-add-from-stream"></a><h3>ctpl_environ_add_from_stream ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            ctpl_environ_add_from_stream        (<em class="parameter"><code><a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a> *env</code></em>,
                                                         <em class="parameter"><code><a class="link" href="ctpl-CtplInputStream.html#CtplInputStream" title="CtplInputStream"><span class="type">CtplInputStream</span></a> *stream</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Loads an environment description from a <a class="link" href="ctpl-CtplInputStream.html#CtplInputStream" title="CtplInputStream"><span class="type">CtplInputStream</span></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>env</code></em> :</span></p></td>
<td>A <a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a> to fill</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>stream</code></em> :</span></p></td>
<td>A <a class="link" href="ctpl-CtplInputStream.html#CtplInputStream" title="CtplInputStream"><span class="type">CtplInputStream</span></a> from where read the environment description.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>Return location for an error, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore them</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ctpl-environ-add-from-path"></a><h3>ctpl_environ_add_from_path ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            ctpl_environ_add_from_path          (<em class="parameter"><code><a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a> *env</code></em>,
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Loads an environment description from a path.
See <a class="link" href="ctpl-CtplEnviron.html#ctpl-environ-add-from-stream" title="ctpl_environ_add_from_stream ()"><code class="function">ctpl_environ_add_from_stream()</code></a>.
</p>
<p>
Errors can come from the <a href="/usr/share/gtk-doc/html/gio/gio-GIOError.html#G-IO-ERROR:CAPS"><code class="literal">G_IO_ERROR</code></a> domain if the file loading failed, or
from the <a class="link" href="ctpl-CtplEnviron.html#CTPL-ENVIRON-ERROR:CAPS" title="CTPL_ENVIRON_ERROR"><code class="literal">CTPL_ENVIRON_ERROR</code></a> domain if the parsing of the environment
description failed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>env</code></em> :</span></p></td>
<td>A <a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a> to fill</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
<td>The path of the file from which load the environment description, in
the GLib's filename encoding</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>Return location for an error, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore them</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="ctpl-environ-add-from-string"></a><h3>ctpl_environ_add_from_string ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            ctpl_environ_add_from_string        (<em class="parameter"><code><a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a> *env</code></em>,
                                                         <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *string</code></em>,
                                                         <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Loads an environment description from a string.
See <a class="link" href="ctpl-CtplEnviron.html#ctpl-environ-add-from-stream" title="ctpl_environ_add_from_stream ()"><code class="function">ctpl_environ_add_from_stream()</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>env</code></em> :</span></p></td>
<td>A <a class="link" href="ctpl-CtplEnviron.html#CtplEnviron" title="CtplEnviron"><span class="type">CtplEnviron</span></a> to fill</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>string</code></em> :</span></p></td>
<td>A string containing an environment description</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>Return location for an error, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to ignore them</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.17</div>
</body>
</html>