libinfinity-0.6-doc 0.6.7-2 / usr / share / gtk-doc / html / libinfinoted-plugin-manager-0.6 / libinfinoted-plugin-manager-0.6-InfinotedParameter.html

This file is indexed.

/usr/share/gtk-doc/html/libinfinoted-plugin-manager-0.6/libinfinoted-plugin-manager-0.6-InfinotedParameter.html is in libinfinity-0.6-doc 0.6.7-2.

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
 671
 672
 673
 674
 675
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685
 686
 687
 688
 689
 690
 691
 692
 693
 694
 695
 696
 697
 698
 699
 700
 701
 702
 703
 704
 705
 706
 707
 708
 709
 710
 711
 712
 713
 714
 715
 716
 717
 718
 719
 720
 721
 722
 723
 724
 725
 726
 727
 728
 729
 730
 731
 732
 733
 734
 735
 736
 737
 738
 739
 740
 741
 742
 743
 744
 745
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755
 756
 757
 758
 759
 760
 761
 762
 763
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773
 774
 775
 776
 777
 778
 779
 780
 781
 782
 783
 784
 785
 786
 787
 788
 789
 790
 791
 792
 793
 794
 795
 796
 797
 798
 799
 800
 801
 802
 803
 804
 805
 806
 807
 808
 809
 810
 811
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835
 836
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871
 872
 873
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901
 902
 903
 904
 905
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>InfinotedParameter: libinfinoted-plugin-manager-0.6 Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="libinfinoted-plugin-manager-0.6 Reference Manual">
<link rel="up" href="ch01.html" title="libinfinoted-plugin-manager API reference">
<link rel="prev" href="InfinotedPluginManager.html" title="InfinotedPluginManager">
<link rel="next" href="InfinotedLog.html" title="InfinotedLog">
<meta name="generator" content="GTK-Doc V1.25 (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="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#libinfinoted-plugin-manager-0.6-InfinotedParameter.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="InfinotedPluginManager.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="InfinotedLog.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libinfinoted-plugin-manager-0.6-InfinotedParameter"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libinfinoted-plugin-manager-0.6-InfinotedParameter.top_of_page"></a>InfinotedParameter</span></h2>
<p>InfinotedParameter — Declare parameters of infinoted plugins.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libinfinoted-plugin-manager-0.6-InfinotedParameter.stability-level"></a><h2>Stability Level</h2>
<a href="http://foldoc.org/Unstable"><span class="acronym">Unstable</span></a>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="libinfinoted-plugin-manager-0.6-InfinotedParameter.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<span class="c_punctuation">(</span><a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#InfinotedParameterConvertFunc" title="InfinotedParameterConvertFunc ()">*InfinotedParameterConvertFunc</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#InfinotedParameterTypedValue" title="struct InfinotedParameterTypedValue"><span class="returnvalue">InfinotedParameterTypedValue</span></a> *
</td>
<td class="function_name">
<a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#infinoted-parameter-typed-value-new" title="infinoted_parameter_typed_value_new ()">infinoted_parameter_typed_value_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#infinoted-parameter-typed-value-free" title="infinoted_parameter_typed_value_free ()">infinoted_parameter_typed_value_free</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GQuark</span>
</td>
<td class="function_name">
<a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#infinoted-parameter-error-quark" title="infinoted_parameter_error_quark ()">infinoted_parameter_error_quark</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#infinoted-parameter-load-from-key-file" title="infinoted_parameter_load_from_key_file ()">infinoted_parameter_load_from_key_file</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#infinoted-parameter-convert-boolean" title="infinoted_parameter_convert_boolean ()">infinoted_parameter_convert_boolean</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#infinoted-parameter-convert-filename" title="infinoted_parameter_convert_filename ()">infinoted_parameter_convert_filename</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#infinoted-parameter-convert-nonnegative" title="infinoted_parameter_convert_nonnegative ()">infinoted_parameter_convert_nonnegative</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#infinoted-parameter-convert-port" title="infinoted_parameter_convert_port ()">infinoted_parameter_convert_port</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#infinoted-parameter-convert-positive" title="infinoted_parameter_convert_positive ()">infinoted_parameter_convert_positive</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#infinoted-parameter-convert-security-policy" title="infinoted_parameter_convert_security_policy ()">infinoted_parameter_convert_security_policy</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#infinoted-parameter-convert-string" title="infinoted_parameter_convert_string ()">infinoted_parameter_convert_string</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#infinoted-parameter-convert-string-list" title="infinoted_parameter_convert_string_list ()">infinoted_parameter_convert_string_list</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libinfinoted-plugin-manager-0.6-InfinotedParameter.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#InfinotedParameterType" title="enum InfinotedParameterType">InfinotedParameterType</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#InfinotedParameterFlags" title="enum InfinotedParameterFlags">InfinotedParameterFlags</a></td>
</tr>
<tr>
<td class="datatype_keyword">union</td>
<td class="function_name"><a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#InfinotedParameterValue" title="union InfinotedParameterValue">InfinotedParameterValue</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#InfinotedParameterTypedValue" title="struct InfinotedParameterTypedValue">InfinotedParameterTypedValue</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#InfinotedParameterInfo" title="struct InfinotedParameterInfo">InfinotedParameterInfo</a></td>
</tr>
<tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#InfinotedParameterError" title="enum InfinotedParameterError">InfinotedParameterError</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libinfinoted-plugin-manager-0.6-InfinotedParameter.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;infinoted/infinoted-parameter.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="libinfinoted-plugin-manager-0.6-InfinotedParameter.description"></a><h2>Description</h2>
<p>The <a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#InfinotedParameterInfo" title="struct InfinotedParameterInfo"><span class="type">InfinotedParameterInfo</span></a> structure allows to declare a parameter that
can then be used as an input value to a plugin. While the types for input
data are limited, the mechanism allows to provide a powerful validation and
transformation function which can turn the input value to the final
internal representation in the plugin data structure.</p>
<p>Parameters are declared by providing a <a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#InfinotedParameterInfo" title="struct InfinotedParameterInfo"><span class="type">InfinotedParameterInfo</span></a> structure,
and an array of such structures is then given to <a class="link" href="InfinotedPluginManager.html#InfinotedPlugin" title="struct InfinotedPlugin"><span class="type">InfinotedPlugin</span></a> which
declares a plugin.</p>
</div>
<div class="refsect1">
<a name="libinfinoted-plugin-manager-0.6-InfinotedParameter.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="InfinotedParameterConvertFunc"></a><h3>InfinotedParameterConvertFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
<span class="c_punctuation">(</span>*InfinotedParameterConvertFunc<span class="c_punctuation">)</span> (<em class="parameter"><code><span class="type">gpointer</span> out</code></em>,
                                  <em class="parameter"><code><span class="type">gpointer</span> in</code></em>,
                                  <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Definition of a parameter conversion function. A parameter conversion
function transforms the value of a read which is one of the
<em class="parameter"><code>InfinotedParameterValue</code></em>
 enumeration to its final internal representation.
It can change the C type of the parameter, and it can also validate the
input and produce an error if the input value is invalid.</p>
<p>While plugin developers can write their own conversion functions, many are
already provided by libinfinoted-plugin-manager that cover the most basic
usecases. These functions are 
<a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#infinoted-parameter-convert-string" title="infinoted_parameter_convert_string ()"><code class="function">infinoted_parameter_convert_string()</code></a>,
<a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#infinoted-parameter-convert-string-list" title="infinoted_parameter_convert_string_list ()"><code class="function">infinoted_parameter_convert_string_list()</code></a>,
<a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#infinoted-parameter-convert-filename" title="infinoted_parameter_convert_filename ()"><code class="function">infinoted_parameter_convert_filename()</code></a>,
<a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#infinoted-parameter-convert-boolean" title="infinoted_parameter_convert_boolean ()"><code class="function">infinoted_parameter_convert_boolean()</code></a>,
<a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#infinoted-parameter-convert-port" title="infinoted_parameter_convert_port ()"><code class="function">infinoted_parameter_convert_port()</code></a>,
<a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#infinoted-parameter-convert-nonnegative" title="infinoted_parameter_convert_nonnegative ()"><code class="function">infinoted_parameter_convert_nonnegative()</code></a>,
<a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#infinoted-parameter-convert-positive" title="infinoted_parameter_convert_positive ()"><code class="function">infinoted_parameter_convert_positive()</code></a>, and
<a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#infinoted-parameter-convert-security-policy" title="infinoted_parameter_convert_security_policy ()"><code class="function">infinoted_parameter_convert_security_policy()</code></a>.</p>
<div class="refsect3">
<a name="InfinotedParameterConvertFunc.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>Location where the converted value should be written to.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>in</p></td>
<td class="parameter_description"><p>Location where the original input value should be taken from.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Location for error information, if any, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="InfinotedParameterConvertFunc.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> on success or <code class="literal">FALSE</code> if an error occurred.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="infinoted-parameter-typed-value-new"></a><h3>infinoted_parameter_typed_value_new ()</h3>
<pre class="programlisting"><a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#InfinotedParameterTypedValue" title="struct InfinotedParameterTypedValue"><span class="returnvalue">InfinotedParameterTypedValue</span></a> *
infinoted_parameter_typed_value_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Creates a new instance of a <em class="parameter"><code>InfinotedParameterTypedValue</code></em>
. The new instance
will be uninitialized. Its <em class="parameter"><code>type</code></em>
 and <em class="parameter"><code>value</code></em>
 members need to be set before
the object can be used or given to <a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#infinoted-parameter-typed-value-free" title="infinoted_parameter_typed_value_free ()"><code class="function">infinoted_parameter_typed_value_free()</code></a>.</p>
<div class="refsect3">
<a name="infinoted-parameter-typed-value-new.returns"></a><h4>Returns</h4>
<p> A new <a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#InfinotedParameterTypedValue" title="struct InfinotedParameterTypedValue"><span class="type">InfinotedParameterTypedValue</span></a>. Free with
<a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#infinoted-parameter-typed-value-free" title="infinoted_parameter_typed_value_free ()"><code class="function">infinoted_parameter_typed_value_free()</code></a> when no longer needed.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="infinoted-parameter-typed-value-free"></a><h3>infinoted_parameter_typed_value_free ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
infinoted_parameter_typed_value_free (<em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
<p>Frees an instance of <a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#InfinotedParameterTypedValue" title="struct InfinotedParameterTypedValue"><span class="type">InfinotedParameterTypedValue</span></a>. Formally the argument
is kept as a generic pointer so that this function can be used as a
<span class="type">GDestroyNotify</span> callback.</p>
<p>Note that the <a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#InfinotedParameterTypedValue" title="struct InfinotedParameterTypedValue"><span class="type">InfinotedParameterTypedValue</span></a> needs to be correctly
initialized, i.e. its type must be set, before it can be freed.</p>
<div class="refsect3">
<a name="infinoted-parameter-typed-value-free.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>data</p></td>
<td class="parameter_description"><p>The <a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#InfinotedParameterTypedValue" title="struct InfinotedParameterTypedValue"><span class="type">InfinotedParameterTypedValue</span></a> to free.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="infinoted-parameter-error-quark"></a><h3>infinoted_parameter_error_quark ()</h3>
<pre class="programlisting"><span class="returnvalue">GQuark</span>
infinoted_parameter_error_quark (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Returns the <span class="type">GQuark</span> for errors from the InfinotedParameter module.</p>
<div class="refsect3">
<a name="infinoted-parameter-error-quark.returns"></a><h4>Returns</h4>
<p> The error domain for the InfinotedParameter module.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="infinoted-parameter-load-from-key-file"></a><h3>infinoted_parameter_load_from_key_file ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
infinoted_parameter_load_from_key_file
                               (<em class="parameter"><code>const <a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#InfinotedParameterInfo" title="struct InfinotedParameterInfo"><span class="type">InfinotedParameterInfo</span></a> *infos</code></em>,
                                <em class="parameter"><code><span class="type">GKeyFile</span> *key_file</code></em>,
                                <em class="parameter"><code>const <span class="type">gchar</span> *group</code></em>,
                                <em class="parameter"><code><span class="type">gpointer</span> base</code></em>,
                                <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Attempts to read each parameter in <em class="parameter"><code>infos</code></em>
 from <em class="parameter"><code>key_file</code></em>
 and store them in
a user-specified structure <em class="parameter"><code>base</code></em>
. The <em class="parameter"><code>offset</code></em>
 field of
<a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#InfinotedParameterInfo" title="struct InfinotedParameterInfo"><span class="type">InfinotedParameterInfo</span></a> specifies where inside <em class="parameter"><code>base</code></em>
 the read parameter
value will be written, and the <em class="parameter"><code>convert</code></em>
 field specifies a function which
converts the parameter type (integer, string or string list) into the
type of the field in the target structure.</p>
<p>If the key file does not have an entry for one of the entries in <em class="parameter"><code>infos</code></em>
,
then the current value in the base structure is untouched. This allows
setting default values prior to calling this function.</p>
<p>If the function fails, for example because the conversion into the target
type failed (which, in turn, might be due to invalid user input), <code class="literal">FALSE</code>
is returned and <em class="parameter"><code>error</code></em>
 is set.</p>
<div class="refsect3">
<a name="infinoted-parameter-load-from-key-file.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>infos</p></td>
<td class="parameter_description"><p>A 0-terminated array of <a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#InfinotedParameterInfo" title="struct InfinotedParameterInfo"><span class="type">InfinotedParameterInfo</span></a> objects.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>key_file</p></td>
<td class="parameter_description"><p>The <span class="type">GKeyFile</span> to load parameter values from.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>group</p></td>
<td class="parameter_description"><p>The keyfile group to load the values from.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>base</p></td>
<td class="parameter_description"><p>The instance into which to write the read parameters.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Location to store error information, if any, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="infinoted-parameter-load-from-key-file.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> on success, otherwise <code class="literal">FALSE</code>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="infinoted-parameter-convert-boolean"></a><h3>infinoted_parameter_convert_boolean ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
infinoted_parameter_convert_boolean (<em class="parameter"><code><span class="type">gpointer</span> out</code></em>,
                                     <em class="parameter"><code><span class="type">gpointer</span> in</code></em>,
                                     <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>This function simply writes the boolean value from <em class="parameter"><code>in</code></em>
 to <em class="parameter"><code>out</code></em>
 without any
further validation.</p>
<p>This is a <a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#InfinotedParameterConvertFunc" title="InfinotedParameterConvertFunc ()"><span class="type">InfinotedParameterConvertFunc</span></a> function that can be used for
boolean values.</p>
<div class="refsect3">
<a name="infinoted-parameter-convert-boolean.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>The pointer to the output <span class="type">gboolean</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>in</p></td>
<td class="parameter_description"><p>The pointer to the input <span class="type">gboolean</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Location to store error information, if any, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="infinoted-parameter-convert-boolean.returns"></a><h4>Returns</h4>
<p> This function always returns <code class="literal">TRUE</code>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="infinoted-parameter-convert-filename"></a><h3>infinoted_parameter_convert_filename ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
infinoted_parameter_convert_filename (<em class="parameter"><code><span class="type">gpointer</span> out</code></em>,
                                      <em class="parameter"><code><span class="type">gpointer</span> in</code></em>,
                                      <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>This function converts the input string from UTF-8
to the Glib file name encoding.</p>
<p>This is a <a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#InfinotedParameterConvertFunc" title="InfinotedParameterConvertFunc ()"><span class="type">InfinotedParameterConvertFunc</span></a> function that can be used for
strings that should be in Glib file name encoding format instead of
UTF-8.</p>
<div class="refsect3">
<a name="infinoted-parameter-convert-filename.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>The pointer to the output string location.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>in</p></td>
<td class="parameter_description"><p>A pointer to the input string location.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Location to store error information, if any, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="infinoted-parameter-convert-filename.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> on success, or <code class="literal">FALSE</code> otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="infinoted-parameter-convert-nonnegative"></a><h3>infinoted_parameter_convert_nonnegative ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
infinoted_parameter_convert_nonnegative
                               (<em class="parameter"><code><span class="type">gpointer</span> out</code></em>,
                                <em class="parameter"><code><span class="type">gpointer</span> in</code></em>,
                                <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>This function validates the input number to be non-negative, and
converts it into an unsigned integer.</p>
<p>This is a <a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#InfinotedParameterConvertFunc" title="InfinotedParameterConvertFunc ()"><span class="type">InfinotedParameterConvertFunc</span></a> function that can be used for
any non-negative numbers.</p>
<div class="refsect3">
<a name="infinoted-parameter-convert-nonnegative.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>The pointer to the output <span class="type">guint</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>in</p></td>
<td class="parameter_description"><p>The pointer to the input <span class="type">gint</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Location to store error information, if any, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="infinoted-parameter-convert-nonnegative.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> on success, or <code class="literal">FALSE</code> otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="infinoted-parameter-convert-port"></a><h3>infinoted_parameter_convert_port ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
infinoted_parameter_convert_port (<em class="parameter"><code><span class="type">gpointer</span> out</code></em>,
                                  <em class="parameter"><code><span class="type">gpointer</span> in</code></em>,
                                  <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>This function validates the input number to be in the valid range for
TCP or UDP ports between 1 and 65535, and converts it to an unsigned
integer.</p>
<p>This is a <a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#InfinotedParameterConvertFunc" title="InfinotedParameterConvertFunc ()"><span class="type">InfinotedParameterConvertFunc</span></a> function that can be used for
TCP or UDP port numbers.</p>
<div class="refsect3">
<a name="infinoted-parameter-convert-port.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>The pointer to the output <span class="type">guint</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>in</p></td>
<td class="parameter_description"><p>The pointer to the input <span class="type">gint</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Location to store error information, if any, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="infinoted-parameter-convert-port.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> on success, or <code class="literal">FALSE</code> otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="infinoted-parameter-convert-positive"></a><h3>infinoted_parameter_convert_positive ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
infinoted_parameter_convert_positive (<em class="parameter"><code><span class="type">gpointer</span> out</code></em>,
                                      <em class="parameter"><code><span class="type">gpointer</span> in</code></em>,
                                      <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>This function validates the input number to be positve, i.e. greater than
zero, and converts it into an unsigned integer.</p>
<p>This is a <a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#InfinotedParameterConvertFunc" title="InfinotedParameterConvertFunc ()"><span class="type">InfinotedParameterConvertFunc</span></a> function that can be used for
any non-negative numbers.</p>
<div class="refsect3">
<a name="infinoted-parameter-convert-positive.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>The pointer to the output <span class="type">guint</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>in</p></td>
<td class="parameter_description"><p>The pointer to the input <span class="type">gint</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Location to store error information, if any, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="infinoted-parameter-convert-positive.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> on success, or <code class="literal">FALSE</code> otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="infinoted-parameter-convert-security-policy"></a><h3>infinoted_parameter_convert_security_policy ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
infinoted_parameter_convert_security_policy
                               (<em class="parameter"><code><span class="type">gpointer</span> out</code></em>,
                                <em class="parameter"><code><span class="type">gpointer</span> in</code></em>,
                                <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Converts the string that <em class="parameter"><code>in</code></em>
 points to to an
<a href="../html/InfXmppConnection.html#InfXmppConnectionSecurityPolicy"><span class="type">InfXmppConnectionSecurityPolicy</span></a> value, by requiring that it is either
"no-tls", "allow-tls" or "require-tls". If the string is none of these
three the function fails and <em class="parameter"><code>error</code></em>
 is set.</p>
<p>This is a <a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#InfinotedParameterConvertFunc" title="InfinotedParameterConvertFunc ()"><span class="type">InfinotedParameterConvertFunc</span></a> function that can be used for
fields of type <a href="../html/InfXmppConnection.html#InfXmppConnectionSecurityPolicy"><span class="type">InfXmppConnectionSecurityPolicy</span></a>.</p>
<div class="refsect3">
<a name="infinoted-parameter-convert-security-policy.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>The pointer to the output <a href="../html/InfXmppConnection.html#InfXmppConnectionSecurityPolicy"><span class="type">InfXmppConnectionSecurityPolicy</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>in</p></td>
<td class="parameter_description"><p>The pointer to the input string location.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Location to store error information, if any, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="infinoted-parameter-convert-security-policy.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> on success, or <code class="literal">FALSE</code> otherwise.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="infinoted-parameter-convert-string"></a><h3>infinoted_parameter_convert_string ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
infinoted_parameter_convert_string (<em class="parameter"><code><span class="type">gpointer</span> out</code></em>,
                                    <em class="parameter"><code><span class="type">gpointer</span> in</code></em>,
                                    <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>This is basically a no-op, moving the string from the <em class="parameter"><code>in</code></em>
 location to the
<em class="parameter"><code>out</code></em>
 location. In case <em class="parameter"><code>in</code></em>
 points to the empty string, it is freed and the
output string is set to be <code class="literal">NULL</code>.</p>
<p>This is a <a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#InfinotedParameterConvertFunc" title="InfinotedParameterConvertFunc ()"><span class="type">InfinotedParameterConvertFunc</span></a> function that can be used for
strings that should not be processed further or validated.</p>
<div class="refsect3">
<a name="infinoted-parameter-convert-string.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>The pointer to the output string location.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>in</p></td>
<td class="parameter_description"><p>A pointer to the input string location.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Location to store error information, if any, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="infinoted-parameter-convert-string.returns"></a><h4>Returns</h4>
<p> This function always returns <code class="literal">TRUE</code>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="infinoted-parameter-convert-string-list"></a><h3>infinoted_parameter_convert_string_list ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
infinoted_parameter_convert_string_list
                               (<em class="parameter"><code><span class="type">gpointer</span> out</code></em>,
                                <em class="parameter"><code><span class="type">gpointer</span> in</code></em>,
                                <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>This is basically a no-op, moving the string list from the <em class="parameter"><code>in</code></em>
 location to
the <em class="parameter"><code>out</code></em>
 location. In case <em class="parameter"><code>in</code></em>
 points to an empty string list, or to a
string list with only one entry which is the empty string, then the string
list is freed and the output string list is set to be <code class="literal">NULL</code>.</p>
<p>This is a <a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#InfinotedParameterConvertFunc" title="InfinotedParameterConvertFunc ()"><span class="type">InfinotedParameterConvertFunc</span></a> function that can be used for
string lists that should not be processed further or validated.</p>
<div class="refsect3">
<a name="infinoted-parameter-convert-string-list.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>out</p></td>
<td class="parameter_description"><p>The pointer to the output string list.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>in</p></td>
<td class="parameter_description"><p>The pointer to the input string list.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>Location to store error information, if any, or <code class="literal">NULL</code>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="infinoted-parameter-convert-string-list.returns"></a><h4>Returns</h4>
<p> This function always returns <code class="literal">TRUE</code>.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="libinfinoted-plugin-manager-0.6-InfinotedParameter.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="InfinotedParameterType"></a><h3>enum InfinotedParameterType</h3>
<p>Allowed types for a parameter that can be given to a infinoted plugin.</p>
<div class="refsect3">
<a name="InfinotedParameterType.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="INFINOTED-PARAMETER-BOOLEAN:CAPS"></a>INFINOTED_PARAMETER_BOOLEAN</p></td>
<td class="enum_member_description">
<p>A boolean parameter.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INFINOTED-PARAMETER-INT:CAPS"></a>INFINOTED_PARAMETER_INT</p></td>
<td class="enum_member_description">
<p>A signed integer parameter.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INFINOTED-PARAMETER-STRING:CAPS"></a>INFINOTED_PARAMETER_STRING</p></td>
<td class="enum_member_description">
<p>A string parameter.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INFINOTED-PARAMETER-STRING-LIST:CAPS"></a>INFINOTED_PARAMETER_STRING_LIST</p></td>
<td class="enum_member_description">
<p>An array of strings.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="InfinotedParameterFlags"></a><h3>enum InfinotedParameterFlags</h3>
<p>Additional flags for parameters that can be given to infinoted plugins.</p>
<div class="refsect3">
<a name="InfinotedParameterFlags.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody><tr>
<td class="enum_member_name"><p><a name="INFINOTED-PARAMETER-REQUIRED:CAPS"></a>INFINOTED_PARAMETER_REQUIRED</p></td>
<td class="enum_member_description">
<p>The parameter is required and cannot be
omitted.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="InfinotedParameterValue"></a><h3>union InfinotedParameterValue</h3>
<p>Holds the value of a infinoted parameter. The type of the parameter must
be known. See also <a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#InfinotedParameterTypedValue" title="struct InfinotedParameterTypedValue"><span class="type">InfinotedParameterTypedValue</span></a>.</p>
<div class="refsect3">
<a name="InfinotedParameterValue.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="union_members_name">
<col class="union_members_description">
<col width="200px" class="union_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="union_member_name"><p><span class="type">gboolean</span> <em class="structfield"><code><a name="InfinotedParameterValue.yesno"></a>yesno</code></em>;</p></td>
<td class="union_member_description"><p>The parameter value for type <a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#INFINOTED-PARAMETER-BOOLEAN:CAPS"><code class="literal">INFINOTED_PARAMETER_BOOLEAN</code></a>.</p></td>
<td class="union_member_annotations"> </td>
</tr>
<tr>
<td class="union_member_name"><p><span class="type">gint</span> <em class="structfield"><code><a name="InfinotedParameterValue.number"></a>number</code></em>;</p></td>
<td class="union_member_description"><p>The parameter value for type <a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#INFINOTED-PARAMETER-INT:CAPS"><code class="literal">INFINOTED_PARAMETER_INT</code></a>.</p></td>
<td class="union_member_annotations"> </td>
</tr>
<tr>
<td class="union_member_name"><p><span class="type">gchar</span> *<em class="structfield"><code><a name="InfinotedParameterValue.str"></a>str</code></em>;</p></td>
<td class="union_member_description"><p>The parameter value for type <a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#INFINOTED-PARAMETER-STRING:CAPS"><code class="literal">INFINOTED_PARAMETER_STRING</code></a>.</p></td>
<td class="union_member_annotations"> </td>
</tr>
<tr>
<td class="union_member_name"><p><span class="type">gchar</span> **<em class="structfield"><code><a name="InfinotedParameterValue.strv"></a>strv</code></em>;</p></td>
<td class="union_member_description"><p>The parameter value for type <a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#INFINOTED-PARAMETER-STRING-LIST:CAPS"><code class="literal">INFINOTED_PARAMETER_STRING_LIST</code></a>.</p></td>
<td class="union_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="InfinotedParameterTypedValue"></a><h3>struct InfinotedParameterTypedValue</h3>
<pre class="programlisting">struct InfinotedParameterTypedValue {
  InfinotedParameterType type;
  InfinotedParameterValue value;
};
</pre>
<p>Holds the type and value of a parameter that can be passed to an
infinoted plugin.</p>
<div class="refsect3">
<a name="InfinotedParameterTypedValue.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#InfinotedParameterType" title="enum InfinotedParameterType"><span class="type">InfinotedParameterType</span></a> <em class="structfield"><code><a name="InfinotedParameterTypedValue.type"></a>type</code></em>;</p></td>
<td class="struct_member_description"><p>The type of the parameter.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#InfinotedParameterValue" title="union InfinotedParameterValue"><span class="type">InfinotedParameterValue</span></a> <em class="structfield"><code><a name="InfinotedParameterTypedValue.value"></a>value</code></em>;</p></td>
<td class="struct_member_description"><p>The value of the parameter.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="InfinotedParameterInfo"></a><h3>struct InfinotedParameterInfo</h3>
<pre class="programlisting">struct InfinotedParameterInfo {
  const char* name;
  InfinotedParameterType type;
  InfinotedParameterFlags flags;
  size_t offset;
  InfinotedParameterConvertFunc convert;
  char short_name;
  const char* description;
  const char* arg_description;
};
</pre>
<p>This structure contains generic information about a parameter that can
be passed to an infinoted plugin.</p>
<div class="refsect3">
<a name="InfinotedParameterInfo.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p>const <span class="type">char</span> *<em class="structfield"><code><a name="InfinotedParameterInfo.name"></a>name</code></em>;</p></td>
<td class="struct_member_description"><p>The name of the parameter.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#InfinotedParameterType" title="enum InfinotedParameterType"><span class="type">InfinotedParameterType</span></a> <em class="structfield"><code><a name="InfinotedParameterInfo.type"></a>type</code></em>;</p></td>
<td class="struct_member_description"><p>The input type of the parameter.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#InfinotedParameterFlags" title="enum InfinotedParameterFlags"><span class="type">InfinotedParameterFlags</span></a> <em class="structfield"><code><a name="InfinotedParameterInfo.flags"></a>flags</code></em>;</p></td>
<td class="struct_member_description"><p>Additional flags for the parameter.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">size_t</span> <em class="structfield"><code><a name="InfinotedParameterInfo.offset"></a>offset</code></em>;</p></td>
<td class="struct_member_description"><p>Offset of the output value in the structure of the plugin. Should
be determined with <code class="literal">G_STRUCT_OFFSET</code>.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#InfinotedParameterConvertFunc" title="InfinotedParameterConvertFunc ()"><span class="type">InfinotedParameterConvertFunc</span></a> <em class="structfield"><code><a name="InfinotedParameterInfo.convert"></a>convert</code></em>;</p></td>
<td class="struct_member_description"><p>The conversion function for the parameter, see
<a class="link" href="libinfinoted-plugin-manager-0.6-InfinotedParameter.html#InfinotedParameterConvertFunc" title="InfinotedParameterConvertFunc ()"><span class="type">InfinotedParameterConvertFunc</span></a>.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><span class="type">char</span> <em class="structfield"><code><a name="InfinotedParameterInfo.short-name"></a>short_name</code></em>;</p></td>
<td class="struct_member_description"><p>A short name (one character) for the parameter, used for
command line option parsing.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p>const <span class="type">char</span> *<em class="structfield"><code><a name="InfinotedParameterInfo.description"></a>description</code></em>;</p></td>
<td class="struct_member_description"><p>A description for the parameter that can be shown in
<code class="literal">--help</code> output</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p>const <span class="type">char</span> *<em class="structfield"><code><a name="InfinotedParameterInfo.arg-description"></a>arg_description</code></em>;</p></td>
<td class="struct_member_description"><p>A description for the argument of the parameter in
<code class="literal">--help</code> output, if any.</p></td>
<td class="struct_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="InfinotedParameterError"></a><h3>enum InfinotedParameterError</h3>
<p>Specifies the possible error conditions for errors in the
<code class="literal">INFINOTED_PARAMETER_ERROR</code> domain. These typically
occur when parsing and processing input parameters for plugins.</p>
<div class="refsect3">
<a name="InfinotedParameterError.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="INFINOTED-PARAMETER-ERROR-REQUIRED:CAPS"></a>INFINOTED_PARAMETER_ERROR_REQUIRED</p></td>
<td class="enum_member_description">
<p>A parameter is required but was not
provided to the plugin.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INFINOTED-PARAMETER-ERROR-INVALID-NUMBER:CAPS"></a>INFINOTED_PARAMETER_ERROR_INVALID_NUMBER</p></td>
<td class="enum_member_description">
<p>The number given as a parameter
is not valid, for example a negative time interval.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="INFINOTED-PARAMETER-ERROR-INVALID-SECURITY-POLICY:CAPS"></a>INFINOTED_PARAMETER_ERROR_INVALID_SECURITY_POLICY</p></td>
<td class="enum_member_description">
<p>A security policy given
as a parameter is not valid. The only allowed values are
"no-tls", "allow-tls", and "require-tls".</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.