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
|
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<!--
This file is autogenerated from html/libvirt-libvirt-common.html.in
Do not edit this file. Changes will be lost.
-->
<!--
This page was generated at Thu Jan 10 20:48:18 UTC 2019.
-->
<head>
<meta charset="UTF-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<link rel="stylesheet" type="text/css" href="../main.css"/>
<link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png"/>
<link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png"/>
<link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png"/>
<link rel="manifest" href="/manifest.json"/>
<meta name="theme-color" content="#ffffff"/>
<title>libvirt: Module libvirt-common from libvirt</title>
<meta name="description" content="libvirt, virtualization, virtualization API"/>
<script type="text/javascript">
<!--
function init() {
window.addEventListener('scroll', function(e){
var distanceY = window.pageYOffset || document.documentElement.scrollTop,
shrinkOn = 94
home = document.getElementById("home");
links = document.getElementById("jumplinks");
search = document.getElementById("search");
body = document.getElementById("body");
if (distanceY > shrinkOn) {
if (home.className != "navhide") {
body.className = "navhide"
home.className = "navhide"
links.className = "navhide"
search.className = "navhide"
}
} else {
if (home.className == "navhide") {
body.className = ""
home.className = ""
links.className = ""
search.className = ""
}
}
});
}
window.onload = init();
-->
</script>
</head>
<body>
<div id="body">
<div id="content">
<h1>Module libvirt-common from libvirt</h1>
<p>Provides common macros and enums needed by both libvirt and libvirt-admin libraries Copyright (C) 2015 Red Hat, Inc. This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details. You should have received a copy of the GNU Lesser General Public License along with this library. If not, see <a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>.</p>
<h2>Table of Contents</h2>
<h3>
<a href="#macros">Macros</a>
</h3>
<pre class="api"><span class="directive">#define</span> <a href="#LIBVIR_CHECK_VERSION">LIBVIR_CHECK_VERSION</a>
<span class="directive">#define</span> <a href="#LIBVIR_VERSION_NUMBER">LIBVIR_VERSION_NUMBER</a>
<span class="directive">#define</span> <a href="#VIR_TYPED_PARAM_FIELD_LENGTH">VIR_TYPED_PARAM_FIELD_LENGTH</a>
</pre>
<h3>
<a href="#types">Types</a>
</h3>
<pre class="api"><span class="keyword">typedef</span> <span class="keyword">enum</span> <a href="#virConnectCloseReason">virConnectCloseReason</a>
<span class="keyword">typedef</span> <span class="type">struct _virTypedParameter</span> <a href="#virTypedParameter">virTypedParameter</a>
<span class="keyword">typedef</span> <span class="keyword">enum</span> <a href="#virTypedParameterFlags">virTypedParameterFlags</a>
<span class="keyword">typedef</span> <span class="type"><a href="libvirt-libvirt-common.html#virTypedParameter">virTypedParameter</a> *</span> <a name="virTypedParameterPtr">virTypedParameterPtr</a>
<span class="keyword">typedef</span> <span class="keyword">enum</span> <a href="#virTypedParameterType">virTypedParameterType</a>
</pre>
<h3>
<a href="#functions">Functions</a>
</h3>
<pre class="api"><span class="keyword">typedef</span> <a href="#virFreeCallback">virFreeCallback</a>
<span class="type">void</span> <a href="#virFreeCallback">virFreeCallback</a> (<span class="type">void *</span> opaque)
<span class="type">int</span> <a href="#virTypedParamsAddBoolean">virTypedParamsAddBoolean</a> (<span class="type"><a href="libvirt-libvirt-common.html#virTypedParameterPtr">virTypedParameterPtr</a> *</span> params, <br/> <span class="type">int *</span> nparams, <br/> <span class="type">int *</span> maxparams, <br/> <span class="type">const char *</span> name, <br/> <span class="type">int</span> value)
<span class="type">int</span> <a href="#virTypedParamsAddDouble">virTypedParamsAddDouble</a> (<span class="type"><a href="libvirt-libvirt-common.html#virTypedParameterPtr">virTypedParameterPtr</a> *</span> params, <br/> <span class="type">int *</span> nparams, <br/> <span class="type">int *</span> maxparams, <br/> <span class="type">const char *</span> name, <br/> <span class="type">double</span> value)
<span class="type">int</span> <a href="#virTypedParamsAddFromString">virTypedParamsAddFromString</a> (<span class="type"><a href="libvirt-libvirt-common.html#virTypedParameterPtr">virTypedParameterPtr</a> *</span> params, <br/> <span class="type">int *</span> nparams, <br/> <span class="type">int *</span> maxparams, <br/> <span class="type">const char *</span> name, <br/> <span class="type">int</span> type, <br/> <span class="type">const char *</span> value)
<span class="type">int</span> <a href="#virTypedParamsAddInt">virTypedParamsAddInt</a> (<span class="type"><a href="libvirt-libvirt-common.html#virTypedParameterPtr">virTypedParameterPtr</a> *</span> params, <br/> <span class="type">int *</span> nparams, <br/> <span class="type">int *</span> maxparams, <br/> <span class="type">const char *</span> name, <br/> <span class="type">int</span> value)
<span class="type">int</span> <a href="#virTypedParamsAddLLong">virTypedParamsAddLLong</a> (<span class="type"><a href="libvirt-libvirt-common.html#virTypedParameterPtr">virTypedParameterPtr</a> *</span> params, <br/> <span class="type">int *</span> nparams, <br/> <span class="type">int *</span> maxparams, <br/> <span class="type">const char *</span> name, <br/> <span class="type">long long</span> value)
<span class="type">int</span> <a href="#virTypedParamsAddString">virTypedParamsAddString</a> (<span class="type"><a href="libvirt-libvirt-common.html#virTypedParameterPtr">virTypedParameterPtr</a> *</span> params, <br/> <span class="type">int *</span> nparams, <br/> <span class="type">int *</span> maxparams, <br/> <span class="type">const char *</span> name, <br/> <span class="type">const char *</span> value)
<span class="type">int</span> <a href="#virTypedParamsAddStringList">virTypedParamsAddStringList</a> (<span class="type"><a href="libvirt-libvirt-common.html#virTypedParameterPtr">virTypedParameterPtr</a> *</span> params, <br/> <span class="type">int *</span> nparams, <br/> <span class="type">int *</span> maxparams, <br/> <span class="type">const char *</span> name, <br/> <span class="type">const char **</span> values)
<span class="type">int</span> <a href="#virTypedParamsAddUInt">virTypedParamsAddUInt</a> (<span class="type"><a href="libvirt-libvirt-common.html#virTypedParameterPtr">virTypedParameterPtr</a> *</span> params, <br/> <span class="type">int *</span> nparams, <br/> <span class="type">int *</span> maxparams, <br/> <span class="type">const char *</span> name, <br/> <span class="type">unsigned int</span> value)
<span class="type">int</span> <a href="#virTypedParamsAddULLong">virTypedParamsAddULLong</a> (<span class="type"><a href="libvirt-libvirt-common.html#virTypedParameterPtr">virTypedParameterPtr</a> *</span> params, <br/> <span class="type">int *</span> nparams, <br/> <span class="type">int *</span> maxparams, <br/> <span class="type">const char *</span> name, <br/> <span class="type">unsigned long long</span> value)
<span class="type">void</span> <a href="#virTypedParamsClear">virTypedParamsClear</a> (<span class="type"><a href="libvirt-libvirt-common.html#virTypedParameterPtr">virTypedParameterPtr</a></span> params, <br/> <span class="type">int</span> nparams)
<span class="type">void</span> <a href="#virTypedParamsFree">virTypedParamsFree</a> (<span class="type"><a href="libvirt-libvirt-common.html#virTypedParameterPtr">virTypedParameterPtr</a></span> params, <br/> <span class="type">int</span> nparams)
<span class="type"><a href="libvirt-libvirt-common.html#virTypedParameterPtr">virTypedParameterPtr</a></span> <a href="#virTypedParamsGet">virTypedParamsGet</a> (<span class="type"><a href="libvirt-libvirt-common.html#virTypedParameterPtr">virTypedParameterPtr</a></span> params, <br/> <span class="type">int</span> nparams, <br/> <span class="type">const char *</span> name)
<span class="type">int</span> <a href="#virTypedParamsGetBoolean">virTypedParamsGetBoolean</a> (<span class="type"><a href="libvirt-libvirt-common.html#virTypedParameterPtr">virTypedParameterPtr</a></span> params, <br/> <span class="type">int</span> nparams, <br/> <span class="type">const char *</span> name, <br/> <span class="type">int *</span> value)
<span class="type">int</span> <a href="#virTypedParamsGetDouble">virTypedParamsGetDouble</a> (<span class="type"><a href="libvirt-libvirt-common.html#virTypedParameterPtr">virTypedParameterPtr</a></span> params, <br/> <span class="type">int</span> nparams, <br/> <span class="type">const char *</span> name, <br/> <span class="type">double *</span> value)
<span class="type">int</span> <a href="#virTypedParamsGetInt">virTypedParamsGetInt</a> (<span class="type"><a href="libvirt-libvirt-common.html#virTypedParameterPtr">virTypedParameterPtr</a></span> params, <br/> <span class="type">int</span> nparams, <br/> <span class="type">const char *</span> name, <br/> <span class="type">int *</span> value)
<span class="type">int</span> <a href="#virTypedParamsGetLLong">virTypedParamsGetLLong</a> (<span class="type"><a href="libvirt-libvirt-common.html#virTypedParameterPtr">virTypedParameterPtr</a></span> params, <br/> <span class="type">int</span> nparams, <br/> <span class="type">const char *</span> name, <br/> <span class="type">long long *</span> value)
<span class="type">int</span> <a href="#virTypedParamsGetString">virTypedParamsGetString</a> (<span class="type"><a href="libvirt-libvirt-common.html#virTypedParameterPtr">virTypedParameterPtr</a></span> params, <br/> <span class="type">int</span> nparams, <br/> <span class="type">const char *</span> name, <br/> <span class="type">const char **</span> value)
<span class="type">int</span> <a href="#virTypedParamsGetUInt">virTypedParamsGetUInt</a> (<span class="type"><a href="libvirt-libvirt-common.html#virTypedParameterPtr">virTypedParameterPtr</a></span> params, <br/> <span class="type">int</span> nparams, <br/> <span class="type">const char *</span> name, <br/> <span class="type">unsigned int *</span> value)
<span class="type">int</span> <a href="#virTypedParamsGetULLong">virTypedParamsGetULLong</a> (<span class="type"><a href="libvirt-libvirt-common.html#virTypedParameterPtr">virTypedParameterPtr</a></span> params, <br/> <span class="type">int</span> nparams, <br/> <span class="type">const char *</span> name, <br/> <span class="type">unsigned long long *</span> value)
</pre>
<h2>Description</h2>
<h3>
<a name="macros">Macros</a>
</h3>
<h3>
<a name="LIBVIR_CHECK_VERSION">
<code>LIBVIR_CHECK_VERSION</code>
</a>
</h3>
<pre class="api"><span class="directive">#define</span> LIBVIR_CHECK_VERSION</pre>
<div class="description">
<p>Macro for developers to easily check what version of the library their code is compiling against. e.g. #if LIBVIR_CHECK_VERSION(1,1,3) // some code that only works in 1.1.3 and newer #endif</p>
</div>
<h3>
<a name="LIBVIR_VERSION_NUMBER">
<code>LIBVIR_VERSION_NUMBER</code>
</a>
</h3>
<pre class="api"><span class="directive">#define</span> LIBVIR_VERSION_NUMBER</pre>
<div class="description">
<p>Macro providing the version of the library as version * 1,000,000 + minor * 1000 + micro</p>
</div>
<h3>
<a name="VIR_TYPED_PARAM_FIELD_LENGTH">
<code>VIR_TYPED_PARAM_FIELD_LENGTH</code>
</a>
</h3>
<pre class="api"><span class="directive">#define</span> VIR_TYPED_PARAM_FIELD_LENGTH</pre>
<div class="description">
<p>Macro providing the field length of <a href="libvirt-libvirt-common.html#virTypedParameter">virTypedParameter</a> name</p>
</div>
<h3>
<a name="types">Types</a>
</h3>
<h3>
<a name="virConnectCloseReason">
<code>virConnectCloseReason</code>
</a>
</h3>
<div class="api">
<pre><span class="keyword">enum</span> virConnectCloseReason {
</pre>
<table>
<tr>
<td>
<a name="VIR_CONNECT_CLOSE_REASON_ERROR">VIR_CONNECT_CLOSE_REASON_ERROR</a>
</td>
<td> = </td>
<td>0</td>
<td>
<div class="comment">Misc I/O error</div>
</td>
</tr>
<tr>
<td>
<a name="VIR_CONNECT_CLOSE_REASON_EOF">VIR_CONNECT_CLOSE_REASON_EOF</a>
</td>
<td> = </td>
<td>1</td>
<td>
<div class="comment">End-of-file from server</div>
</td>
</tr>
<tr>
<td>
<a name="VIR_CONNECT_CLOSE_REASON_KEEPALIVE">VIR_CONNECT_CLOSE_REASON_KEEPALIVE</a>
</td>
<td> = </td>
<td>2</td>
<td>
<div class="comment">Keepalive timer triggered</div>
</td>
</tr>
<tr>
<td>
<a name="VIR_CONNECT_CLOSE_REASON_CLIENT">VIR_CONNECT_CLOSE_REASON_CLIENT</a>
</td>
<td> = </td>
<td>3</td>
<td>
<div class="comment">Client requested it</div>
</td>
</tr>
<tr>
<td>
<a name="VIR_CONNECT_CLOSE_REASON_LAST">VIR_CONNECT_CLOSE_REASON_LAST</a>
</td>
<td> = </td>
<td colspan="2">4</td>
</tr>
</table>
<pre>}
</pre>
</div>
<h3>
<a name="virTypedParameter">
<code>virTypedParameter</code>
</a>
</h3>
<div class="api">
<pre><span class="keyword">struct </span>virTypedParameter {
</pre>
<table>
<tr>
<td>
<span class="type">char field[VIR_TYPED_PARAM_FIELD_LENGTH]</span>
</td>
<td>field</td>
<td>
<div class="comment">parameter name</div>
</td>
</tr>
<tr>
<td>
<span class="type">int</span>
</td>
<td>type</td>
<td>
<div class="comment">parameter type, <a href="libvirt-libvirt-common.html#virTypedParameterType">virTypedParameterType</a></div>
</td>
</tr>
<tr>
<td><span class="keyword">union</span> {</td>
</tr>
<tr>
<td>
<table>
<tr>
<td>
<span class="type">int</span>
</td>
<td>i</td>
<td>
<div class="comment">type is INT</div>
</td>
</tr>
<tr>
<td>
<span class="type">unsigned int</span>
</td>
<td>ui</td>
<td>
<div class="comment">type is UINT</div>
</td>
</tr>
<tr>
<td>
<span class="type">long long int</span>
</td>
<td>l</td>
<td>
<div class="comment">type is LLONG</div>
</td>
</tr>
<tr>
<td>
<span class="type">unsigned long long int</span>
</td>
<td>ul</td>
<td>
<div class="comment">type is ULLONG</div>
</td>
</tr>
<tr>
<td>
<span class="type">double</span>
</td>
<td>d</td>
<td>
<div class="comment">type is DOUBLE</div>
</td>
</tr>
<tr>
<td>
<span class="type">char</span>
</td>
<td>b</td>
<td>
<div class="comment">type is BOOLEAN</div>
</td>
</tr>
<tr>
<td>
<span class="type">char *</span>
</td>
<td>s</td>
<td>
<div class="comment">type is STRING, may not be NULL</div>
</td>
</tr>
</table>
</td>
<td/>
</tr>
<tr>
<td>}</td>
<td>value</td>
<td>
<div class="comment">parameter value</div>
</td>
<td/>
</tr>
</table>
<pre>
}
</pre>
</div>
<h3>
<a name="virTypedParameterFlags">
<code>virTypedParameterFlags</code>
</a>
</h3>
<div class="api">
<pre><span class="keyword">enum</span> virTypedParameterFlags {
</pre>
<table>
<tr>
<td>
<a name="VIR_TYPED_PARAM_STRING_OKAY">VIR_TYPED_PARAM_STRING_OKAY</a>
</td>
<td> = </td>
<td>4</td>
<td>
<div class="comment">1 << 0 is reserved for <a href="libvirt-libvirt-domain.html#virDomainModificationImpact">virDomainModificationImpact</a> 1 << 1 is reserved for <a href="libvirt-libvirt-domain.html#virDomainModificationImpact">virDomainModificationImpact</a> Older servers lacked the ability to handle string typed parameters. Attempts to set a string parameter with an older server will fail at the client, but attempts to retrieve parameters must not return strings from a new server to an older client, so this flag exists to identify newer clients to newer servers. This flag is automatically set when needed, so the user does not have to worry about it; however, manually setting the flag can be used to reject servers that cannot return typed strings, even if no strings would be returned.</div>
</td>
</tr>
</table>
<pre>}
</pre>
</div>
<h3>
<a name="virTypedParameterType">
<code>virTypedParameterType</code>
</a>
</h3>
<div class="api">
<pre><span class="keyword">enum</span> virTypedParameterType {
</pre>
<table>
<tr>
<td>
<a name="VIR_TYPED_PARAM_INT">VIR_TYPED_PARAM_INT</a>
</td>
<td> = </td>
<td>1</td>
<td>
<div class="comment">integer case</div>
</td>
</tr>
<tr>
<td>
<a name="VIR_TYPED_PARAM_UINT">VIR_TYPED_PARAM_UINT</a>
</td>
<td> = </td>
<td>2</td>
<td>
<div class="comment">unsigned integer case</div>
</td>
</tr>
<tr>
<td>
<a name="VIR_TYPED_PARAM_LLONG">VIR_TYPED_PARAM_LLONG</a>
</td>
<td> = </td>
<td>3</td>
<td>
<div class="comment">long long case</div>
</td>
</tr>
<tr>
<td>
<a name="VIR_TYPED_PARAM_ULLONG">VIR_TYPED_PARAM_ULLONG</a>
</td>
<td> = </td>
<td>4</td>
<td>
<div class="comment">unsigned long long case</div>
</td>
</tr>
<tr>
<td>
<a name="VIR_TYPED_PARAM_DOUBLE">VIR_TYPED_PARAM_DOUBLE</a>
</td>
<td> = </td>
<td>5</td>
<td>
<div class="comment">double case</div>
</td>
</tr>
<tr>
<td>
<a name="VIR_TYPED_PARAM_BOOLEAN">VIR_TYPED_PARAM_BOOLEAN</a>
</td>
<td> = </td>
<td>6</td>
<td>
<div class="comment">boolean(character) case</div>
</td>
</tr>
<tr>
<td>
<a name="VIR_TYPED_PARAM_STRING">VIR_TYPED_PARAM_STRING</a>
</td>
<td> = </td>
<td>7</td>
<td>
<div class="comment">string case</div>
</td>
</tr>
<tr>
<td>
<a name="VIR_TYPED_PARAM_LAST">VIR_TYPED_PARAM_LAST</a>
</td>
<td> = </td>
<td colspan="2">8</td>
</tr>
</table>
<pre>}
</pre>
</div>
<h3>
<a name="functions">Functions</a>
</h3>
<h3>
<a name="virFreeCallback">
<code>virFreeCallback</code>
</a>
</h3>
<pre class="api"><span class="keyword">typedef</span> <span class="type">void</span> (*virFreeCallback ) (<span class="type">void *</span> opaque)
</pre>
<div class="description">
<p>Type for a callback cleanup function to be paired with a callback. This function will be called as a final chance to clean up the @opaque registered with the primary callback, at the time when the primary callback is deregistered.</p>
<p>It is forbidden to call any other libvirt APIs from an implementation of this callback, since it can be invoked from a context which is not re-entrant safe. Failure to abide by this requirement may lead to application deadlocks or crashes.</p>
</div>
<dl class="variablelist">
<dt>opaque</dt>
<dd>opaque user data provided at registration</dd>
</dl>
<br/>
<h3>
<a name="virTypedParamsAddBoolean">
<code>virTypedParamsAddBoolean</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virTypedParamsAddBoolean (<span class="type"><a href="libvirt-libvirt-common.html#virTypedParameterPtr">virTypedParameterPtr</a> *</span> params,
<span class="type">int *</span> nparams,
<span class="type">int *</span> maxparams,
<span class="type">const char *</span> name,
<span class="type">int</span> value)</pre>
<div class="description">
<p>Adds new parameter called @name with boolean type and sets its value to @value. If @params array points to NULL or to a space that is not large enough to accommodate the new parameter (@maxparams < @nparams + 1), the function allocates more space for it and updates @maxparams. On success, @nparams is incremented by one. The function fails with <a href="libvirt-virterror.html#VIR_ERR_INVALID_ARG">VIR_ERR_INVALID_ARG</a> error if the parameter already exists in @params.</p>
</div>
<dl class="variablelist">
<dt>params</dt>
<dd>pointer to the array of typed parameters</dd>
<dt>nparams</dt>
<dd>number of parameters in the @params array</dd>
<dt>maxparams</dt>
<dd>maximum number of parameters that can be stored in @params array without allocating more memory</dd>
<dt>name</dt>
<dd>name of the parameter to find</dd>
<dt>value</dt>
<dd>the value to store into the new parameter</dd>
<dt>Returns</dt>
<dd>0 on success, -1 on error.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virTypedParamsAddDouble">
<code>virTypedParamsAddDouble</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virTypedParamsAddDouble (<span class="type"><a href="libvirt-libvirt-common.html#virTypedParameterPtr">virTypedParameterPtr</a> *</span> params,
<span class="type">int *</span> nparams,
<span class="type">int *</span> maxparams,
<span class="type">const char *</span> name,
<span class="type">double</span> value)</pre>
<div class="description">
<p>Adds new parameter called @name with double type and sets its value to @value. If @params array points to NULL or to a space that is not large enough to accommodate the new parameter (@maxparams < @nparams + 1), the function allocates more space for it and updates @maxparams. On success, @nparams is incremented by one. The function fails with <a href="libvirt-virterror.html#VIR_ERR_INVALID_ARG">VIR_ERR_INVALID_ARG</a> error if the parameter already exists in @params.</p>
</div>
<dl class="variablelist">
<dt>params</dt>
<dd>pointer to the array of typed parameters</dd>
<dt>nparams</dt>
<dd>number of parameters in the @params array</dd>
<dt>maxparams</dt>
<dd>maximum number of parameters that can be stored in @params array without allocating more memory</dd>
<dt>name</dt>
<dd>name of the parameter to find</dd>
<dt>value</dt>
<dd>the value to store into the new parameter</dd>
<dt>Returns</dt>
<dd>0 on success, -1 on error.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virTypedParamsAddFromString">
<code>virTypedParamsAddFromString</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virTypedParamsAddFromString (<span class="type"><a href="libvirt-libvirt-common.html#virTypedParameterPtr">virTypedParameterPtr</a> *</span> params,
<span class="type">int *</span> nparams,
<span class="type">int *</span> maxparams,
<span class="type">const char *</span> name,
<span class="type">int</span> type,
<span class="type">const char *</span> value)</pre>
<div class="description">
<p>Adds new parameter called @name with the requested @type and parses its value from the @value string. If the requested type is string, the function creates its own copy of the @value string, which needs to be freed using <a href="libvirt-libvirt-common.html#virTypedParamsFree">virTypedParamsFree</a> or <a href="libvirt-libvirt-common.html#virTypedParamsClear">virTypedParamsClear</a>. If @params array points to NULL or to a space that is not large enough to accommodate the new parameter (@maxparams < @nparams + 1), the function allocates more space for it and updates @maxparams. On success, @nparams is incremented by one. The function fails with <a href="libvirt-virterror.html#VIR_ERR_INVALID_ARG">VIR_ERR_INVALID_ARG</a> error if the parameter already exists in @params.</p>
</div>
<dl class="variablelist">
<dt>params</dt>
<dd>pointer to the array of typed parameters</dd>
<dt>nparams</dt>
<dd>number of parameters in the @params array</dd>
<dt>maxparams</dt>
<dd>maximum number of parameters that can be stored in @params array without allocating more memory</dd>
<dt>name</dt>
<dd>name of the parameter to find</dd>
<dt>type</dt>
<dd>type of the parameter</dd>
<dt>value</dt>
<dd>the value to store into the new parameter encoded as a string</dd>
<dt>Returns</dt>
<dd>0 on success, -1 on error.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virTypedParamsAddInt">
<code>virTypedParamsAddInt</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virTypedParamsAddInt (<span class="type"><a href="libvirt-libvirt-common.html#virTypedParameterPtr">virTypedParameterPtr</a> *</span> params,
<span class="type">int *</span> nparams,
<span class="type">int *</span> maxparams,
<span class="type">const char *</span> name,
<span class="type">int</span> value)</pre>
<div class="description">
<p>Adds new parameter called @name with int type and sets its value to @value. If @params array points to NULL or to a space that is not large enough to accommodate the new parameter (@maxparams < @nparams + 1), the function allocates more space for it and updates @maxparams. On success, @nparams is incremented by one. The function fails with <a href="libvirt-virterror.html#VIR_ERR_INVALID_ARG">VIR_ERR_INVALID_ARG</a> error if the parameter already exists in @params.</p>
</div>
<dl class="variablelist">
<dt>params</dt>
<dd>pointer to the array of typed parameters</dd>
<dt>nparams</dt>
<dd>number of parameters in the @params array</dd>
<dt>maxparams</dt>
<dd>maximum number of parameters that can be stored in @params array without allocating more memory</dd>
<dt>name</dt>
<dd>name of the parameter to find</dd>
<dt>value</dt>
<dd>the value to store into the new parameter</dd>
<dt>Returns</dt>
<dd>0 on success, -1 on error.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virTypedParamsAddLLong">
<code>virTypedParamsAddLLong</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virTypedParamsAddLLong (<span class="type"><a href="libvirt-libvirt-common.html#virTypedParameterPtr">virTypedParameterPtr</a> *</span> params,
<span class="type">int *</span> nparams,
<span class="type">int *</span> maxparams,
<span class="type">const char *</span> name,
<span class="type">long long</span> value)</pre>
<div class="description">
<p>Adds new parameter called @name with long long int type and sets its value to @value. If @params array points to NULL or to a space that is not large enough to accommodate the new parameter (@maxparams < @nparams + 1), the function allocates more space for it and updates @maxparams. On success, @nparams is incremented by one. The function fails with <a href="libvirt-virterror.html#VIR_ERR_INVALID_ARG">VIR_ERR_INVALID_ARG</a> error if the parameter already exists in @params.</p>
</div>
<dl class="variablelist">
<dt>params</dt>
<dd>pointer to the array of typed parameters</dd>
<dt>nparams</dt>
<dd>number of parameters in the @params array</dd>
<dt>maxparams</dt>
<dd>maximum number of parameters that can be stored in @params array without allocating more memory</dd>
<dt>name</dt>
<dd>name of the parameter to find</dd>
<dt>value</dt>
<dd>the value to store into the new parameter</dd>
<dt>Returns</dt>
<dd>0 on success, -1 on error.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virTypedParamsAddString">
<code>virTypedParamsAddString</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virTypedParamsAddString (<span class="type"><a href="libvirt-libvirt-common.html#virTypedParameterPtr">virTypedParameterPtr</a> *</span> params,
<span class="type">int *</span> nparams,
<span class="type">int *</span> maxparams,
<span class="type">const char *</span> name,
<span class="type">const char *</span> value)</pre>
<div class="description">
<p>Adds new parameter called @name with char * type and sets its value to @value. The function creates its own copy of @value string, which needs to be freed using <a href="libvirt-libvirt-common.html#virTypedParamsFree">virTypedParamsFree</a> or <a href="libvirt-libvirt-common.html#virTypedParamsClear">virTypedParamsClear</a>. If @params array points to NULL or to a space that is not large enough to accommodate the new parameter (@maxparams < @nparams + 1), the function allocates more space for it and updates @maxparams. On success, @nparams is incremented by one. The function fails with <a href="libvirt-virterror.html#VIR_ERR_INVALID_ARG">VIR_ERR_INVALID_ARG</a> error if the parameter already exists in @params.</p>
</div>
<dl class="variablelist">
<dt>params</dt>
<dd>pointer to the array of typed parameters</dd>
<dt>nparams</dt>
<dd>number of parameters in the @params array</dd>
<dt>maxparams</dt>
<dd>maximum number of parameters that can be stored in @params array without allocating more memory</dd>
<dt>name</dt>
<dd>name of the parameter to find</dd>
<dt>value</dt>
<dd>the value to store into the new parameter</dd>
<dt>Returns</dt>
<dd>0 on success, -1 on error.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virTypedParamsAddStringList">
<code>virTypedParamsAddStringList</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virTypedParamsAddStringList (<span class="type"><a href="libvirt-libvirt-common.html#virTypedParameterPtr">virTypedParameterPtr</a> *</span> params,
<span class="type">int *</span> nparams,
<span class="type">int *</span> maxparams,
<span class="type">const char *</span> name,
<span class="type">const char **</span> values)</pre>
<div class="description">
<p>Packs NULL-terminated list of strings @values into @params under the key @name.</p>
</div>
<dl class="variablelist">
<dt>params</dt>
<dd>array of typed parameters</dd>
<dt>nparams</dt>
<dd>number of parameters in the @params array</dd>
<dt>maxparams</dt>
<dd>maximum number of parameters that can be stored in @params array without allocating more memory</dd>
<dt>name</dt>
<dd>name of the parameter to store values to</dd>
<dt>values</dt>
<dd>the values to store into the new parameters</dd>
<dt>Returns</dt>
<dd>0 on success, -1 on error.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virTypedParamsAddUInt">
<code>virTypedParamsAddUInt</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virTypedParamsAddUInt (<span class="type"><a href="libvirt-libvirt-common.html#virTypedParameterPtr">virTypedParameterPtr</a> *</span> params,
<span class="type">int *</span> nparams,
<span class="type">int *</span> maxparams,
<span class="type">const char *</span> name,
<span class="type">unsigned int</span> value)</pre>
<div class="description">
<p>Adds new parameter called @name with unsigned int type and sets its value to @value. If @params array points to NULL or to a space that is not large enough to accommodate the new parameter (@maxparams < @nparams + 1), the function allocates more space for it and updates @maxparams. On success, @nparams is incremented by one. The function fails with <a href="libvirt-virterror.html#VIR_ERR_INVALID_ARG">VIR_ERR_INVALID_ARG</a> error if the parameter already exists in @params.</p>
</div>
<dl class="variablelist">
<dt>params</dt>
<dd>pointer to the array of typed parameters</dd>
<dt>nparams</dt>
<dd>number of parameters in the @params array</dd>
<dt>maxparams</dt>
<dd>maximum number of parameters that can be stored in @params array without allocating more memory</dd>
<dt>name</dt>
<dd>name of the parameter to find</dd>
<dt>value</dt>
<dd>the value to store into the new parameter</dd>
<dt>Returns</dt>
<dd>0 on success, -1 on error.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virTypedParamsAddULLong">
<code>virTypedParamsAddULLong</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virTypedParamsAddULLong (<span class="type"><a href="libvirt-libvirt-common.html#virTypedParameterPtr">virTypedParameterPtr</a> *</span> params,
<span class="type">int *</span> nparams,
<span class="type">int *</span> maxparams,
<span class="type">const char *</span> name,
<span class="type">unsigned long long</span> value)</pre>
<div class="description">
<p>Adds new parameter called @name with unsigned long long type and sets its value to @value. If @params array points to NULL or to a space that is not large enough to accommodate the new parameter (@maxparams < @nparams + 1), the function allocates more space for it and updates @maxparams. On success, @nparams is incremented by one. The function fails with <a href="libvirt-virterror.html#VIR_ERR_INVALID_ARG">VIR_ERR_INVALID_ARG</a> error if the parameter already exists in @params.</p>
</div>
<dl class="variablelist">
<dt>params</dt>
<dd>pointer to the array of typed parameters</dd>
<dt>nparams</dt>
<dd>number of parameters in the @params array</dd>
<dt>maxparams</dt>
<dd>maximum number of parameters that can be stored in @params array without allocating more memory</dd>
<dt>name</dt>
<dd>name of the parameter to find</dd>
<dt>value</dt>
<dd>the value to store into the new parameter</dd>
<dt>Returns</dt>
<dd>0 on success, -1 on error.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virTypedParamsClear">
<code>virTypedParamsClear</code>
</a>
</h3>
<pre class="api"><span class="type">void</span> virTypedParamsClear (<span class="type"><a href="libvirt-libvirt-common.html#virTypedParameterPtr">virTypedParameterPtr</a></span> params,
<span class="type">int</span> nparams)</pre>
<div class="description">
<p>Frees all memory used by string parameters. The memory occupied by @params is not freed; use <a href="libvirt-libvirt-common.html#virTypedParamsFree">virTypedParamsFree</a> if you want it to be freed too.</p>
</div>
<dl class="variablelist">
<dt>params</dt>
<dd>the array of typed parameters</dd>
<dt>nparams</dt>
<dd>number of parameters in the @params array</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virTypedParamsFree">
<code>virTypedParamsFree</code>
</a>
</h3>
<pre class="api"><span class="type">void</span> virTypedParamsFree (<span class="type"><a href="libvirt-libvirt-common.html#virTypedParameterPtr">virTypedParameterPtr</a></span> params,
<span class="type">int</span> nparams)</pre>
<div class="description">
<p>Frees all memory used by string parameters and the memory occupied by @params.</p>
</div>
<dl class="variablelist">
<dt>params</dt>
<dd>the array of typed parameters</dd>
<dt>nparams</dt>
<dd>number of parameters in the @params array</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virTypedParamsGet">
<code>virTypedParamsGet</code>
</a>
</h3>
<pre class="api"><span class="type"><a href="libvirt-libvirt-common.html#virTypedParameterPtr">virTypedParameterPtr</a></span> virTypedParamsGet (<span class="type"><a href="libvirt-libvirt-common.html#virTypedParameterPtr">virTypedParameterPtr</a></span> params,
<span class="type">int</span> nparams,
<span class="type">const char *</span> name)</pre>
<div class="description">
<p>Finds typed parameter called @name.</p>
</div>
<dl class="variablelist">
<dt>params</dt>
<dd>array of typed parameters</dd>
<dt>nparams</dt>
<dd>number of parameters in the @params array</dd>
<dt>name</dt>
<dd>name of the parameter to find</dd>
<dt>Returns</dt>
<dd>pointer to the parameter or NULL if it does not exist in @params. This function does not raise an error, even when returning NULL.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virTypedParamsGetBoolean">
<code>virTypedParamsGetBoolean</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virTypedParamsGetBoolean (<span class="type"><a href="libvirt-libvirt-common.html#virTypedParameterPtr">virTypedParameterPtr</a></span> params,
<span class="type">int</span> nparams,
<span class="type">const char *</span> name,
<span class="type">int *</span> value)</pre>
<div class="description">
<p>Finds typed parameter called @name and store its boolean value in @value. The function fails with <a href="libvirt-virterror.html#VIR_ERR_INVALID_ARG">VIR_ERR_INVALID_ARG</a> error if the parameter does not have the expected type. By passing NULL as @value, the function may be used to check presence and type of the parameter.</p>
</div>
<dl class="variablelist">
<dt>params</dt>
<dd>array of typed parameters</dd>
<dt>nparams</dt>
<dd>number of parameters in the @params array</dd>
<dt>name</dt>
<dd>name of the parameter to find</dd>
<dt>value</dt>
<dd>where to store the parameter's value</dd>
<dt>Returns</dt>
<dd>1 on success, 0 when the parameter does not exist in @params, or -1 on error.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virTypedParamsGetDouble">
<code>virTypedParamsGetDouble</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virTypedParamsGetDouble (<span class="type"><a href="libvirt-libvirt-common.html#virTypedParameterPtr">virTypedParameterPtr</a></span> params,
<span class="type">int</span> nparams,
<span class="type">const char *</span> name,
<span class="type">double *</span> value)</pre>
<div class="description">
<p>Finds typed parameter called @name and store its double value in @value. The function fails with <a href="libvirt-virterror.html#VIR_ERR_INVALID_ARG">VIR_ERR_INVALID_ARG</a> error if the parameter does not have the expected type. By passing NULL as @value, the function may be used to check presence and type of the parameter.</p>
</div>
<dl class="variablelist">
<dt>params</dt>
<dd>array of typed parameters</dd>
<dt>nparams</dt>
<dd>number of parameters in the @params array</dd>
<dt>name</dt>
<dd>name of the parameter to find</dd>
<dt>value</dt>
<dd>where to store the parameter's value</dd>
<dt>Returns</dt>
<dd>1 on success, 0 when the parameter does not exist in @params, or -1 on error.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virTypedParamsGetInt">
<code>virTypedParamsGetInt</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virTypedParamsGetInt (<span class="type"><a href="libvirt-libvirt-common.html#virTypedParameterPtr">virTypedParameterPtr</a></span> params,
<span class="type">int</span> nparams,
<span class="type">const char *</span> name,
<span class="type">int *</span> value)</pre>
<div class="description">
<p>Finds typed parameter called @name and store its int value in @value. The function fails with <a href="libvirt-virterror.html#VIR_ERR_INVALID_ARG">VIR_ERR_INVALID_ARG</a> error if the parameter does not have the expected type. By passing NULL as @value, the function may be used to check presence and type of the parameter.</p>
</div>
<dl class="variablelist">
<dt>params</dt>
<dd>array of typed parameters</dd>
<dt>nparams</dt>
<dd>number of parameters in the @params array</dd>
<dt>name</dt>
<dd>name of the parameter to find</dd>
<dt>value</dt>
<dd>where to store the parameter's value</dd>
<dt>Returns</dt>
<dd>1 on success, 0 when the parameter does not exist in @params, or -1 on error.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virTypedParamsGetLLong">
<code>virTypedParamsGetLLong</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virTypedParamsGetLLong (<span class="type"><a href="libvirt-libvirt-common.html#virTypedParameterPtr">virTypedParameterPtr</a></span> params,
<span class="type">int</span> nparams,
<span class="type">const char *</span> name,
<span class="type">long long *</span> value)</pre>
<div class="description">
<p>Finds typed parameter called @name and store its long long int value in @value. The function fails with <a href="libvirt-virterror.html#VIR_ERR_INVALID_ARG">VIR_ERR_INVALID_ARG</a> error if the parameter does not have the expected type. By passing NULL as @value, the function may be used to check presence and type of the parameter.</p>
</div>
<dl class="variablelist">
<dt>params</dt>
<dd>array of typed parameters</dd>
<dt>nparams</dt>
<dd>number of parameters in the @params array</dd>
<dt>name</dt>
<dd>name of the parameter to find</dd>
<dt>value</dt>
<dd>where to store the parameter's value</dd>
<dt>Returns</dt>
<dd>1 on success, 0 when the parameter does not exist in @params, or -1 on error.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virTypedParamsGetString">
<code>virTypedParamsGetString</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virTypedParamsGetString (<span class="type"><a href="libvirt-libvirt-common.html#virTypedParameterPtr">virTypedParameterPtr</a></span> params,
<span class="type">int</span> nparams,
<span class="type">const char *</span> name,
<span class="type">const char **</span> value)</pre>
<div class="description">
<p>Finds typed parameter called @name and store its char * value in @value. The function does not create a copy of the string and the caller must not free the string @value points to. The function fails with <a href="libvirt-virterror.html#VIR_ERR_INVALID_ARG">VIR_ERR_INVALID_ARG</a> error if the parameter does not have the expected type. By passing NULL as @value, the function may be used to check presence and type of the parameter.</p>
</div>
<dl class="variablelist">
<dt>params</dt>
<dd>array of typed parameters</dd>
<dt>nparams</dt>
<dd>number of parameters in the @params array</dd>
<dt>name</dt>
<dd>name of the parameter to find</dd>
<dt>value</dt>
<dd>where to store the parameter's value</dd>
<dt>Returns</dt>
<dd>1 on success, 0 when the parameter does not exist in @params, or -1 on error.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virTypedParamsGetUInt">
<code>virTypedParamsGetUInt</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virTypedParamsGetUInt (<span class="type"><a href="libvirt-libvirt-common.html#virTypedParameterPtr">virTypedParameterPtr</a></span> params,
<span class="type">int</span> nparams,
<span class="type">const char *</span> name,
<span class="type">unsigned int *</span> value)</pre>
<div class="description">
<p>Finds typed parameter called @name and store its unsigned int value in @value. The function fails with <a href="libvirt-virterror.html#VIR_ERR_INVALID_ARG">VIR_ERR_INVALID_ARG</a> error if the parameter does not have the expected type. By passing NULL as @value, the function may be used to check presence and type of the parameter.</p>
</div>
<dl class="variablelist">
<dt>params</dt>
<dd>array of typed parameters</dd>
<dt>nparams</dt>
<dd>number of parameters in the @params array</dd>
<dt>name</dt>
<dd>name of the parameter to find</dd>
<dt>value</dt>
<dd>where to store the parameter's value</dd>
<dt>Returns</dt>
<dd>1 on success, 0 when the parameter does not exist in @params, or -1 on error.</dd>
</dl>
<div class="acl"/>
<h3>
<a name="virTypedParamsGetULLong">
<code>virTypedParamsGetULLong</code>
</a>
</h3>
<pre class="api"><span class="type">int</span> virTypedParamsGetULLong (<span class="type"><a href="libvirt-libvirt-common.html#virTypedParameterPtr">virTypedParameterPtr</a></span> params,
<span class="type">int</span> nparams,
<span class="type">const char *</span> name,
<span class="type">unsigned long long *</span> value)</pre>
<div class="description">
<p>Finds typed parameter called @name and store its unsigned long long int value in @value. The function fails with <a href="libvirt-virterror.html#VIR_ERR_INVALID_ARG">VIR_ERR_INVALID_ARG</a> error if the parameter does not have the expected type. By passing NULL as @value, the function may be used to check presence and type of the parameter.</p>
</div>
<dl class="variablelist">
<dt>params</dt>
<dd>array of typed parameters</dd>
<dt>nparams</dt>
<dd>number of parameters in the @params array</dd>
<dt>name</dt>
<dd>name of the parameter to find</dd>
<dt>value</dt>
<dd>where to store the parameter's value</dd>
<dt>Returns</dt>
<dd>1 on success, 0 when the parameter does not exist in @params, or -1 on error.</dd>
</dl>
<div class="acl"/>
</div>
</div>
<div id="nav">
<div id="home">
<a href="../index.html">Home</a>
</div>
<div id="jumplinks">
<ul>
<li>
<a href="../downloads.html">Download</a>
</li>
<li>
<a href="../contribute.html">Contribute</a>
</li>
<li>
<a href="../docs.html">Docs</a>
</li>
</ul>
</div>
<div id="search">
<form action="../search.php" enctype="application/x-www-form-urlencoded" method="get">
<div>
<input name="query" type="text" size="12" value=""/>
<input name="submit" type="submit" value="Go"/>
</div>
</form>
</div>
</div>
<div id="footer">
<div id="contact">
<h3>Contact</h3>
<ul>
<li>
<a href="../contact.html#email">email</a>
</li>
<li>
<a href="../contact.html#irc">irc</a>
</li>
</ul>
</div>
<div id="community">
<h3>Community</h3>
<ul>
<li>
<a href="https://twitter.com/hashtag/libvirt">twitter</a>
</li>
<li>
<a href="https://plus.google.com/communities/109522598353007505282">google+</a>
</li>
<li>
<a href="http://stackoverflow.com/questions/tagged/libvirt">stackoverflow</a>
</li>
<li>
<a href="http://serverfault.com/questions/tagged/libvirt">serverfault</a>
</li>
</ul>
</div>
<div id="conduct">
Participants in the libvirt project agree to abide by <a href="../governance.html#codeofconduct">the project code of conduct</a></div>
<br class="clear"/>
</div>
</body>
</html>
|
