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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Libical API Documentation: icalparameter.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Libical API Documentation
 <span id="projectnumber">3.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_b7a0ea939f6e83384f3c571d31a84be9.html">libical</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">icalparameter.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a href="icalparameter_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:adca99971f21bcb7259f54c524837003e"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparameter_8h.html#adca99971f21bcb7259f54c524837003e">icalparameter_as_ical_string</a> (icalparameter *parameter)</td></tr>
<tr class="memdesc:adca99971f21bcb7259f54c524837003e"><td class="mdescLeft"> </td><td class="mdescRight">Convert ::icalparameter into an string representation. <a href="#adca99971f21bcb7259f54c524837003e">More...</a><br /></td></tr>
<tr class="separator:adca99971f21bcb7259f54c524837003e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adfc8b22df1d5ead58b47fd83b772c9b0"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparameter_8h.html#adfc8b22df1d5ead58b47fd83b772c9b0">icalparameter_as_ical_string_r</a> (icalparameter *parameter)</td></tr>
<tr class="memdesc:adfc8b22df1d5ead58b47fd83b772c9b0"><td class="mdescLeft"> </td><td class="mdescRight">Convert ::icalparameter into an string representation. <a href="#adfc8b22df1d5ead58b47fd83b772c9b0">More...</a><br /></td></tr>
<tr class="separator:adfc8b22df1d5ead58b47fd83b772c9b0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aafadb9fd4172bab0d17252d251c69800"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a> (icalparameter *parameter)</td></tr>
<tr class="memdesc:aafadb9fd4172bab0d17252d251c69800"><td class="mdescLeft"> </td><td class="mdescRight">Frees an ::icalparameter object. <a href="#aafadb9fd4172bab0d17252d251c69800">More...</a><br /></td></tr>
<tr class="separator:aafadb9fd4172bab0d17252d251c69800"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa89e6b3abb7ecc6fece2f56db84e813f"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparameter_8h.html#aa89e6b3abb7ecc6fece2f56db84e813f">icalparameter_get_iana_name</a> (icalparameter *param)</td></tr>
<tr class="memdesc:aa89e6b3abb7ecc6fece2f56db84e813f"><td class="mdescLeft"> </td><td class="mdescRight">Returns the IANA name of <em>param</em>. <a href="#aa89e6b3abb7ecc6fece2f56db84e813f">More...</a><br /></td></tr>
<tr class="separator:aa89e6b3abb7ecc6fece2f56db84e813f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af315ea93079ce834a1cfd68a67294aab"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparameter_8h.html#af315ea93079ce834a1cfd68a67294aab">icalparameter_get_iana_value</a> (icalparameter *param)</td></tr>
<tr class="memdesc:af315ea93079ce834a1cfd68a67294aab"><td class="mdescLeft"> </td><td class="mdescRight">Returns the IANA value of <em>param</em>. <a href="#af315ea93079ce834a1cfd68a67294aab">More...</a><br /></td></tr>
<tr class="separator:af315ea93079ce834a1cfd68a67294aab"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0e5cea8520c67d68a9f129838a9a6e83"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparameter_8h.html#a0e5cea8520c67d68a9f129838a9a6e83">icalparameter_get_xname</a> (icalparameter *param)</td></tr>
<tr class="memdesc:a0e5cea8520c67d68a9f129838a9a6e83"><td class="mdescLeft"> </td><td class="mdescRight">Returns the X-name of <em>param</em>. <a href="#a0e5cea8520c67d68a9f129838a9a6e83">More...</a><br /></td></tr>
<tr class="separator:a0e5cea8520c67d68a9f129838a9a6e83"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a97de698d7db2cab7c894c67b3d8fb673"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparameter_8h.html#a97de698d7db2cab7c894c67b3d8fb673">icalparameter_get_xvalue</a> (icalparameter *param)</td></tr>
<tr class="memdesc:a97de698d7db2cab7c894c67b3d8fb673"><td class="mdescLeft"> </td><td class="mdescRight">Returns the X-value of <em>param</em>. <a href="#a97de698d7db2cab7c894c67b3d8fb673">More...</a><br /></td></tr>
<tr class="separator:a97de698d7db2cab7c894c67b3d8fb673"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:add735467f8a84b476f5899e262a072a2"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparameter_8h.html#add735467f8a84b476f5899e262a072a2">icalparameter_has_same_name</a> (icalparameter *param1, icalparameter *param2)</td></tr>
<tr class="memdesc:add735467f8a84b476f5899e262a072a2"><td class="mdescLeft"> </td><td class="mdescRight">Determines if two parameters have the same name. <a href="#add735467f8a84b476f5899e262a072a2">More...</a><br /></td></tr>
<tr class="separator:add735467f8a84b476f5899e262a072a2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0671e8fcd545049a3fbc1b5d5d0f2b2b"><td class="memItemLeft" align="right" valign="top">icalparameter_kind </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparameter_8h.html#a0671e8fcd545049a3fbc1b5d5d0f2b2b">icalparameter_isa</a> (icalparameter *parameter)</td></tr>
<tr class="memdesc:a0671e8fcd545049a3fbc1b5d5d0f2b2b"><td class="mdescLeft"> </td><td class="mdescRight">Returns the icalparameter_kind of parameter. <a href="#a0671e8fcd545049a3fbc1b5d5d0f2b2b">More...</a><br /></td></tr>
<tr class="separator:a0671e8fcd545049a3fbc1b5d5d0f2b2b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a960908ba27797c51f965b997be99f284"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparameter_8h.html#a960908ba27797c51f965b997be99f284">icalparameter_isa_parameter</a> (void *param)</td></tr>
<tr class="memdesc:a960908ba27797c51f965b997be99f284"><td class="mdescLeft"> </td><td class="mdescRight">Determine if the given param is an icalparameter. <a href="#a960908ba27797c51f965b997be99f284">More...</a><br /></td></tr>
<tr class="separator:a960908ba27797c51f965b997be99f284"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af2bc3ace454dda792d4847dcc919d241"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparameter_8h.html#af2bc3ace454dda792d4847dcc919d241">icalparameter_kind_to_string</a> (icalparameter_kind kind)</td></tr>
<tr class="memdesc:af2bc3ace454dda792d4847dcc919d241"><td class="mdescLeft"> </td><td class="mdescRight">Returns a string representing the given ::icalparameter_kind. <a href="#af2bc3ace454dda792d4847dcc919d241">More...</a><br /></td></tr>
<tr class="separator:af2bc3ace454dda792d4847dcc919d241"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2ac8c2694443398bd6253e4a5ab2c3b0"><td class="memItemLeft" align="right" valign="top">icalparameter * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparameter_8h.html#a2ac8c2694443398bd6253e4a5ab2c3b0">icalparameter_new</a> (icalparameter_kind kind)</td></tr>
<tr class="memdesc:a2ac8c2694443398bd6253e4a5ab2c3b0"><td class="mdescLeft"> </td><td class="mdescRight">Creates new ::icalparameter object. <a href="#a2ac8c2694443398bd6253e4a5ab2c3b0">More...</a><br /></td></tr>
<tr class="separator:a2ac8c2694443398bd6253e4a5ab2c3b0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a560f57eddaa8d43f28a3b9b758563581"><td class="memItemLeft" align="right" valign="top">icalparameter * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparameter_8h.html#a560f57eddaa8d43f28a3b9b758563581">icalparameter_new_clone</a> (icalparameter *p)</td></tr>
<tr class="memdesc:a560f57eddaa8d43f28a3b9b758563581"><td class="mdescLeft"> </td><td class="mdescRight">Creates new ::icalparameter as a clone of the given one. <a href="#a560f57eddaa8d43f28a3b9b758563581">More...</a><br /></td></tr>
<tr class="separator:a560f57eddaa8d43f28a3b9b758563581"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a742e0609475e48232a0e5208184d3767"><td class="memItemLeft" align="right" valign="top">icalparameter * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparameter_8h.html#a742e0609475e48232a0e5208184d3767">icalparameter_new_from_string</a> (const char *value)</td></tr>
<tr class="memdesc:a742e0609475e48232a0e5208184d3767"><td class="mdescLeft"> </td><td class="mdescRight">Create ::icalparameter object from string. <a href="#a742e0609475e48232a0e5208184d3767">More...</a><br /></td></tr>
<tr class="separator:a742e0609475e48232a0e5208184d3767"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6f785010533a0f63de5ef811d7ea0e87"><td class="memItemLeft" align="right" valign="top">icalparameter * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparameter_8h.html#a6f785010533a0f63de5ef811d7ea0e87">icalparameter_new_from_value_string</a> (icalparameter_kind kind, const char *value)</td></tr>
<tr class="memdesc:a6f785010533a0f63de5ef811d7ea0e87"><td class="mdescLeft"> </td><td class="mdescRight">Create ::icalparameter of a given <em>kind</em> with a given <em>value</em>. <a href="#a6f785010533a0f63de5ef811d7ea0e87">More...</a><br /></td></tr>
<tr class="separator:a6f785010533a0f63de5ef811d7ea0e87"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aab70ecf438e02384a5a13ca6a71e7793"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparameter_8h.html#aab70ecf438e02384a5a13ca6a71e7793">icalparameter_set_iana_name</a> (icalparameter *param, const char *v)</td></tr>
<tr class="memdesc:aab70ecf438e02384a5a13ca6a71e7793"><td class="mdescLeft"> </td><td class="mdescRight">Sets the IANA name of <em>param</em> to <em>v</em>. <a href="#aab70ecf438e02384a5a13ca6a71e7793">More...</a><br /></td></tr>
<tr class="separator:aab70ecf438e02384a5a13ca6a71e7793"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adf6329d175597783232853ff1ca53e24"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparameter_8h.html#adf6329d175597783232853ff1ca53e24">icalparameter_set_iana_value</a> (icalparameter *param, const char *v)</td></tr>
<tr class="memdesc:adf6329d175597783232853ff1ca53e24"><td class="mdescLeft"> </td><td class="mdescRight">Sets the IANA value of <em>param</em> to <em>v</em>. <a href="#adf6329d175597783232853ff1ca53e24">More...</a><br /></td></tr>
<tr class="separator:adf6329d175597783232853ff1ca53e24"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2e77cb0c365e67a65487f916ece223da"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparameter_8h.html#a2e77cb0c365e67a65487f916ece223da">icalparameter_set_xname</a> (icalparameter *param, const char *v)</td></tr>
<tr class="memdesc:a2e77cb0c365e67a65487f916ece223da"><td class="mdescLeft"> </td><td class="mdescRight">Sets the X-name of <em>param</em> to <em>v</em>. <a href="#a2e77cb0c365e67a65487f916ece223da">More...</a><br /></td></tr>
<tr class="separator:a2e77cb0c365e67a65487f916ece223da"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaf0fbf906d011f5af3ce38b626906691"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparameter_8h.html#aaf0fbf906d011f5af3ce38b626906691">icalparameter_set_xvalue</a> (icalparameter *param, const char *v)</td></tr>
<tr class="memdesc:aaf0fbf906d011f5af3ce38b626906691"><td class="mdescLeft"> </td><td class="mdescRight">Sets the X-value of <em>param</em> to <em>v</em>. <a href="#aaf0fbf906d011f5af3ce38b626906691">More...</a><br /></td></tr>
<tr class="separator:aaf0fbf906d011f5af3ce38b626906691"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4e659bfa64d0c6c7cc3da29aadc5d3d6"><td class="memItemLeft" align="right" valign="top">icalparameter_kind </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparameter_8h.html#a4e659bfa64d0c6c7cc3da29aadc5d3d6">icalparameter_string_to_kind</a> (const char *string)</td></tr>
<tr class="memdesc:a4e659bfa64d0c6c7cc3da29aadc5d3d6"><td class="mdescLeft"> </td><td class="mdescRight">Returns the ::icalparameter_kind for a given string. <a href="#a4e659bfa64d0c6c7cc3da29aadc5d3d6">More...</a><br /></td></tr>
<tr class="separator:a4e659bfa64d0c6c7cc3da29aadc5d3d6"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Functions to work with ical parameter objects, which represent parameters to property objects. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="adca99971f21bcb7259f54c524837003e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adca99971f21bcb7259f54c524837003e">◆ </a></span>icalparameter_as_ical_string()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* icalparameter_as_ical_string </td>
<td>(</td>
<td class="paramtype">icalparameter * </td>
<td class="paramname"><em>parameter</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert ::icalparameter into an string representation. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">parameter</td><td>The ::icalparameter to convert </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A string representing the parameter according to RFC5445/RFC6868. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="icalparameter_8h.html#adfc8b22df1d5ead58b47fd83b772c9b0" title="Convert ::icalparameter into an string representation. ">icalparameter_as_ical_string_r()</a></dd></dl>
<dl class="section user"><dt>Error handling</dt><dd>If there is any error, the method returns <code>NULL</code>. Furthermore, if <em>parameter</em> is <code>NULL</code>, it also sets <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a> to <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833a2cc8bbcd8c07fc9a16e36f7aae5757b1">ICAL_BADARG_ERROR</a>. If it doesn't recognize the kind of the parameter, it sets <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a> it <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833a2cc8bbcd8c07fc9a16e36f7aae5757b1">ICAL_BADARG_ERROR</a>. If the parameter is otherwise malformed, it sets <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a> to <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833a6ba07679ac440358c3090a351d27f0d8">ICAL_MALFORMEDDATA_ERROR</a>.</dd></dl>
<dl class="section user"><dt>Ownership</dt><dd>Strings returned by this method are owned by libical, they must not be freed and they may be reclaimed with the next call into the library. A version of this function, which returns strings that are not owned by libical, is <a class="el" href="icalparameter_8h.html#adfc8b22df1d5ead58b47fd83b772c9b0" title="Convert ::icalparameter into an string representation. ">icalparameter_as_ical_string_r()</a>.</dd></dl>
<h3>Usage</h3>
<div class="fragment"><div class="line">icalparameter *param = <a class="code" href="icalparameter_8h.html#a742e0609475e48232a0e5208184d3767">icalparameter_new_from_string</a>(<span class="stringliteral">"ROLE=CHAIR"</span>);</div><div class="line"></div><div class="line"><span class="keywordflow">if</span>(param) {</div><div class="line"> printf(<span class="stringliteral">"%s\n"</span>, <a class="code" href="icalparameter_8h.html#adca99971f21bcb7259f54c524837003e">icalparameter_as_ical_string</a>(param));</div><div class="line">}</div><div class="line"></div><div class="line"><a class="code" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div></div><!-- fragment -->
</div>
</div>
<a id="adfc8b22df1d5ead58b47fd83b772c9b0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adfc8b22df1d5ead58b47fd83b772c9b0">◆ </a></span>icalparameter_as_ical_string_r()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* icalparameter_as_ical_string_r </td>
<td>(</td>
<td class="paramtype">icalparameter * </td>
<td class="paramname"><em>param</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Convert ::icalparameter into an string representation. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">parameter</td><td>The ::icalparameter to convert </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A string representing the parameter according to RFC5445/RFC6868. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="icalparameter_8h.html#adca99971f21bcb7259f54c524837003e" title="Convert ::icalparameter into an string representation. ">icalparameter_as_ical_string()</a></dd></dl>
<dl class="section user"><dt>Error handling</dt><dd>If there is any error, the method returns <code>NULL</code>. Furthermore, if parameter is <code>NULL</code>, it also sets <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a> to <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833a2cc8bbcd8c07fc9a16e36f7aae5757b1">ICAL_BADARG_ERROR</a>. If it doesn't recognize the kind of the parameter, it sets <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a> to <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833a2cc8bbcd8c07fc9a16e36f7aae5757b1">ICAL_BADARG_ERROR</a>. If the parameter is otherwise malformed, it sets <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a> to <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833a6ba07679ac440358c3090a351d27f0d8">ICAL_MALFORMEDDATA_ERROR</a>.</dd></dl>
<dl class="section user"><dt>Ownership</dt><dd>Strings returned by this method are owned by the caller, thus they need to be manually <code>free()</code>d after use. A version of this function which returns strings that do not need to be freed manually is <a class="el" href="icalparameter_8h.html#adca99971f21bcb7259f54c524837003e" title="Convert ::icalparameter into an string representation. ">icalparameter_as_ical_string()</a>.</dd></dl>
<h3>Usage</h3>
<div class="fragment"><div class="line">icalparameter *param = <a class="code" href="icalparameter_8h.html#a742e0609475e48232a0e5208184d3767">icalparameter_new_from_string</a>(<span class="stringliteral">"ROLE=CHAIR"</span>);</div><div class="line"></div><div class="line"><span class="keywordflow">if</span>(param) {</div><div class="line"> <span class="keywordtype">char</span> *str = <a class="code" href="icalparameter_8h.html#adca99971f21bcb7259f54c524837003e">icalparameter_as_ical_string</a>(param);</div><div class="line"> printf(<span class="stringliteral">"%s\n"</span>, str);</div><div class="line"> free(str);</div><div class="line">}</div><div class="line"></div><div class="line"><a class="code" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div></div><!-- fragment --><p>Return a string representation of the parameter according to RFC5445/RFC6868.</p>
<p>param = param-name "=" param-value param-name = iana-token / x-token param-value = paramtext /quoted-string paramtext = *SAFE-CHAR quoted-string= DQUOTE *QSAFE-CHAR DQUOTE QSAFE-CHAR = any character except CTLs and DQUOTE SAFE-CHAR = any character except CTLs, DQUOTE. ";", ":", "," </p>
</div>
</div>
<a id="aafadb9fd4172bab0d17252d251c69800"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aafadb9fd4172bab0d17252d251c69800">◆ </a></span>icalparameter_free()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void icalparameter_free </td>
<td>(</td>
<td class="paramtype">icalparameter * </td>
<td class="paramname"><em>parameter</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Frees an ::icalparameter object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">parameter</td><td>The icalparameter to free</td></tr>
</table>
</dd>
</dl>
<p>This method needs to be used on all parameter objects returned from any of the <code>_new()</code> methods including <a class="el" href="icalparameter_8h.html#a2ac8c2694443398bd6253e4a5ab2c3b0" title="Creates new ::icalparameter object. ">icalparameter_new()</a>, <a class="el" href="icalparameter_8h.html#a560f57eddaa8d43f28a3b9b758563581" title="Creates new ::icalparameter as a clone of the given one. ">icalparameter_new_clone()</a>, <a class="el" href="icalparameter_8h.html#a742e0609475e48232a0e5208184d3767" title="Create ::icalparameter object from string. ">icalparameter_new_from_string()</a> and <a class="el" href="icalparameter_8h.html#a6f785010533a0f63de5ef811d7ea0e87" title="Create ::icalparameter of a given kind with a given value. ">icalparameter_new_from_value_string()</a>, when they are not needed anymore and to be released.</p>
<h3>Usage</h3>
<div class="fragment"><div class="line">icalparameter *param = <a class="code" href="icalparameter_8h.html#a2ac8c2694443398bd6253e4a5ab2c3b0">icalparameter_new</a>();</div><div class="line"></div><div class="line"><span class="keywordflow">if</span>(param) {</div><div class="line"> <span class="comment">// use param...</span></div><div class="line">}</div><div class="line"></div><div class="line"><span class="comment">// after use, release it</span></div><div class="line"><a class="code" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div></div><!-- fragment -->
</div>
</div>
<a id="aa89e6b3abb7ecc6fece2f56db84e813f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa89e6b3abb7ecc6fece2f56db84e813f">◆ </a></span>icalparameter_get_iana_name()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* icalparameter_get_iana_name </td>
<td>(</td>
<td class="paramtype">icalparameter * </td>
<td class="paramname"><em>param</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the IANA name of <em>param</em>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">param</td><td>The ::icalparameter whose IANA name is to be returned </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A string representing the IANA name of <em>param</em> </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="icalparameter_8h.html#aab70ecf438e02384a5a13ca6a71e7793" title="Sets the IANA name of param to v. ">icalparameter_set_iana_name()</a></dd></dl>
<dl class="section user"><dt>Error handling</dt><dd>Returns <code>NULL</code> and sets <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a> to <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833a2cc8bbcd8c07fc9a16e36f7aae5757b1">ICAL_BADARG_ERROR</a> when a <code>NULL</code> is passed instead of an ::icalparameter.</dd></dl>
<dl class="section user"><dt>Ownership</dt><dd>The string that is returned stays owned by libical and must not be freed by the caller.</dd></dl>
<h3>Usage</h3>
<div class="fragment"><div class="line"><span class="comment">// creates new parameter</span></div><div class="line">icalparameter *param = <a class="code" href="icalparameter_8h.html#a2ac8c2694443398bd6253e4a5ab2c3b0">icalparameter_new</a>();</div><div class="line"></div><div class="line"><span class="comment">// sets iana name</span></div><div class="line"><a class="code" href="icalparameter_8h.html#aab70ecf438e02384a5a13ca6a71e7793">icalparameter_set_iana_name</a>(param, <span class="stringliteral">"X-TEST"</span>);</div><div class="line"></div><div class="line"><span class="comment">// compare iana name</span></div><div class="line">assert(0 == strcmp(<a class="code" href="icalparameter_8h.html#aa89e6b3abb7ecc6fece2f56db84e813f">icalparameter_get_iana_name</a>(param), <span class="stringliteral">"X-TEST"</span>));</div><div class="line"></div><div class="line"><a class="code" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div></div><!-- fragment -->
</div>
</div>
<a id="af315ea93079ce834a1cfd68a67294aab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af315ea93079ce834a1cfd68a67294aab">◆ </a></span>icalparameter_get_iana_value()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* icalparameter_get_iana_value </td>
<td>(</td>
<td class="paramtype">icalparameter * </td>
<td class="paramname"><em>param</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the IANA value of <em>param</em>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">param</td><td>The ::icalparameter whose value is to be returned </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A string representing the value of <em>param</em> </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="icalparameter_8h.html#adf6329d175597783232853ff1ca53e24" title="Sets the IANA value of param to v. ">icalparameter_set_iana_value()</a></dd></dl>
<dl class="section user"><dt>Error handling</dt><dd>Returns <code>NULL</code> and sets <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a> to <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833a2cc8bbcd8c07fc9a16e36f7aae5757b1">ICAL_BADARG_ERROR</a> when a <code>NULL</code> is passed instead of an ::icalparameter.</dd></dl>
<dl class="section user"><dt>Ownership</dt><dd>The string that is returned stays owned by libical and must not be freed by the caller.</dd></dl>
<h3>Usage</h3>
<div class="fragment"><div class="line"><span class="comment">// create new parameter</span></div><div class="line">icalparameter *param = <a class="code" href="icalparameter_8h.html#a742e0609475e48232a0e5208184d3767">icalparameter_new_from_string</a>(<span class="stringliteral">"ROLE=ATTENDEE"</span>);</div><div class="line"></div><div class="line"><span class="comment">// set role to chair</span></div><div class="line"><a class="code" href="icalparameter_8h.html#adf6329d175597783232853ff1ca53e24">icalparameter_set_iana_value</a>(param, <span class="stringliteral">"CHAIR"</span>);</div><div class="line"></div><div class="line"><span class="comment">// check that it worked</span></div><div class="line">assert(0 == strcmp(<a class="code" href="icalparameter_8h.html#af315ea93079ce834a1cfd68a67294aab">icalparameter_get_iana_value</a>(param), <span class="stringliteral">"SUCCESS"</span>));</div><div class="line"></div><div class="line"><span class="comment">// release memory</span></div><div class="line"><a class="code" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div></div><!-- fragment -->
</div>
</div>
<a id="a0e5cea8520c67d68a9f129838a9a6e83"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0e5cea8520c67d68a9f129838a9a6e83">◆ </a></span>icalparameter_get_xname()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* icalparameter_get_xname </td>
<td>(</td>
<td class="paramtype">icalparameter * </td>
<td class="paramname"><em>param</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the X-name of <em>param</em>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">param</td><td>The ::icalparameter whose X-name is to be returned </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A string representing the X-name of <em>param</em> </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="icalparameter_8h.html#a2e77cb0c365e67a65487f916ece223da" title="Sets the X-name of param to v. ">icalparameter_set_xname()</a></dd></dl>
<dl class="section user"><dt>Error handling</dt><dd>Returns <code>NULL</code> and sets <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a> to <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833a2cc8bbcd8c07fc9a16e36f7aae5757b1">ICAL_BADARG_ERROR</a> when a <code>NULL</code> is passed instead of an ::icalparameter.</dd></dl>
<dl class="section user"><dt>Ownership</dt><dd>The string that is returned stays owned by libical and must not be freed by the caller.</dd></dl>
<h3>Usage</h3>
<div class="fragment"><div class="line"><span class="comment">// creates new parameter</span></div><div class="line">icalparameter *param = <a class="code" href="icalparameter_8h.html#a2ac8c2694443398bd6253e4a5ab2c3b0">icalparameter_new</a>();</div><div class="line"></div><div class="line"><span class="comment">// sets xname</span></div><div class="line"><a class="code" href="icalparameter_8h.html#a2e77cb0c365e67a65487f916ece223da">icalparameter_set_xname</a>(param, <span class="stringliteral">"X-TEST"</span>);</div><div class="line"></div><div class="line"><span class="comment">// compare xname</span></div><div class="line">assert(0 == strcmp(<a class="code" href="icalparameter_8h.html#a0e5cea8520c67d68a9f129838a9a6e83">icalparameter_get_xname</a>(param), <span class="stringliteral">"X-TEST"</span>));</div><div class="line"></div><div class="line"><a class="code" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div></div><!-- fragment -->
</div>
</div>
<a id="a97de698d7db2cab7c894c67b3d8fb673"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a97de698d7db2cab7c894c67b3d8fb673">◆ </a></span>icalparameter_get_xvalue()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* icalparameter_get_xvalue </td>
<td>(</td>
<td class="paramtype">icalparameter * </td>
<td class="paramname"><em>param</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the X-value of <em>param</em>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">param</td><td>The ::icalparameter whose X-value is to be returned </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A string representing the X-value of <em>param</em> </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="icalparameter_8h.html#aaf0fbf906d011f5af3ce38b626906691" title="Sets the X-value of param to v. ">icalparameter_set_xvalue()</a></dd></dl>
<dl class="section user"><dt>Error handling</dt><dd>Returns <code>NULL</code> and sets <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a> to <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833a2cc8bbcd8c07fc9a16e36f7aae5757b1">ICAL_BADARG_ERROR</a> when a <code>NULL</code> is passed instead of an ::icalparameter.</dd></dl>
<dl class="section user"><dt>Ownership</dt><dd>The string that is returned stays owned by libical and must not be freed by the caller.</dd></dl>
<h3>Usage</h3>
<div class="fragment"><div class="line"><span class="comment">// create new parameter</span></div><div class="line">icalparameter *param = <a class="code" href="icalparameter_8h.html#a742e0609475e48232a0e5208184d3767">icalparameter_new_from_string</a>(<span class="stringliteral">"X-TEST=FAIL"</span>);</div><div class="line"></div><div class="line"><span class="comment">// set test to success</span></div><div class="line"><a class="code" href="icalparameter_8h.html#aaf0fbf906d011f5af3ce38b626906691">icalparameter_set_xvalue</a>(param, <span class="stringliteral">"SUCCESS"</span>);</div><div class="line"></div><div class="line"><span class="comment">// check that it worked</span></div><div class="line">assert(0 == strcmp(<a class="code" href="icalparameter_8h.html#a97de698d7db2cab7c894c67b3d8fb673">icalparameter_get_xvalue</a>(param), <span class="stringliteral">"SUCCESS"</span>));</div><div class="line"></div><div class="line"><span class="comment">// release memory</span></div><div class="line"><a class="code" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div></div><!-- fragment -->
</div>
</div>
<a id="add735467f8a84b476f5899e262a072a2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#add735467f8a84b476f5899e262a072a2">◆ </a></span>icalparameter_has_same_name()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int icalparameter_has_same_name </td>
<td>(</td>
<td class="paramtype">icalparameter * </td>
<td class="paramname"><em>param1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">icalparameter * </td>
<td class="paramname"><em>param2</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Determines if two parameters have the same name. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">param1</td><td>First parameter to compare </td></tr>
<tr><td class="paramname">param2</td><td>Second parameter to compare </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if they have the same name, 0 otherwise.</dd></dl>
<dl class="section user"><dt>Error handling</dt><dd>If either of <em>param1</em> or <em>param2</em> are <code>NULL</code>, it returns 0 and sets <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a> to <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833a2cc8bbcd8c07fc9a16e36f7aae5757b1">ICAL_BADARG_ERROR</a>.</dd></dl>
<dl class="section user"><dt>Ownership</dt><dd>Does not take ownership of either ::icalparameter.</dd></dl>
<h3>Example</h3>
<div class="fragment"><div class="line"><span class="comment">// create two parameters</span></div><div class="line">icalparameter *param1 = <a class="code" href="icalparameter_8h.html#a742e0609475e48232a0e5208184d3767">icalparameter_new_from_string</a>(<span class="stringliteral">"ROLE=CHAIR"</span>);</div><div class="line">icalparameter *param2 = <a class="code" href="icalparameter_8h.html#a742e0609475e48232a0e5208184d3767">icalparameter_new_from_string</a>(<span class="stringliteral">"EMAIL=mailto@example.com"</span>);</div><div class="line"></div><div class="line"><span class="comment">// compare parameter names for equality</span></div><div class="line">assert(<a class="code" href="icalparameter_8h.html#add735467f8a84b476f5899e262a072a2">icalparameter_has_same_name</a>(param1, param2) == 0);</div><div class="line"></div><div class="line"><span class="comment">// release memory</span></div><div class="line"><a class="code" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param1);</div><div class="line"><a class="code" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param2);</div></div><!-- fragment -->
</div>
</div>
<a id="a0671e8fcd545049a3fbc1b5d5d0f2b2b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0671e8fcd545049a3fbc1b5d5d0f2b2b">◆ </a></span>icalparameter_isa()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">icalparameter_kind icalparameter_isa </td>
<td>(</td>
<td class="paramtype">icalparameter * </td>
<td class="paramname"><em>parameter</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the icalparameter_kind of parameter. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">parameter</td><td>The icalparameter whose kind to determine </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The icalparameter_kind of the parameter</dd></dl>
<dl class="section user"><dt>Error handling</dt><dd>Returns ::ICAL_NO_PARAMETER when passed <code>NULL</code>.</dd></dl>
<h3>Usage</h3>
<div class="fragment"><div class="line"><span class="comment">// create parameter</span></div><div class="line">icalparameter *param = <a class="code" href="icalparameter_8h.html#a742e0609475e48232a0e5208184d3767">icalparameter_new_from_string</a>(<span class="stringliteral">"ROLE=CHAIR"</span>);</div><div class="line"></div><div class="line"><span class="comment">// check what type of parameter this is</span></div><div class="line">assert(<a class="code" href="icalparameter_8h.html#a0671e8fcd545049a3fbc1b5d5d0f2b2b">icalparameter_isa</a>(param) == ICAL_ROLE_PARAMETER);</div><div class="line"></div><div class="line"><span class="comment">// release memory</span></div><div class="line"><a class="code" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div></div><!-- fragment -->
</div>
</div>
<a id="a960908ba27797c51f965b997be99f284"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a960908ba27797c51f965b997be99f284">◆ </a></span>icalparameter_isa_parameter()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int icalparameter_isa_parameter </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>param</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Determine if the given param is an icalparameter. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">param</td><td>The libical-originated object to check </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if the object is an icalparameter, 0 otherwise. </dd></dl>
<dl class="section note"><dt>Note</dt><dd>This function expects to be given an object originating from libical - if this function is passed anything that is not from libical, it's behavior is undefined.</dd></dl>
<dl class="section user"><dt>Error handling</dt><dd>When given a <code>NULL</code> object, it returns 0.</dd></dl>
<h3>Usage</h3>
<div class="fragment"><div class="line"><span class="comment">// create parameter</span></div><div class="line">icalparameter *param = <a class="code" href="icalparameter_8h.html#a742e0609475e48232a0e5208184d3767">icalparameter_new_from_string</a>(<span class="stringliteral">"ROLE=CHAIR"</span>);</div><div class="line"></div><div class="line"><span class="comment">// check if it's a parameter</span></div><div class="line">assert(<a class="code" href="icalparameter_8h.html#a960908ba27797c51f965b997be99f284">icalparameter_isa_parameter</a>(param));</div><div class="line"></div><div class="line"><span class="comment">// release memory</span></div><div class="line"><a class="code" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div></div><!-- fragment -->
</div>
</div>
<a id="af2bc3ace454dda792d4847dcc919d241"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af2bc3ace454dda792d4847dcc919d241">◆ </a></span>icalparameter_kind_to_string()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char* icalparameter_kind_to_string </td>
<td>(</td>
<td class="paramtype">icalparameter_kind </td>
<td class="paramname"><em>kind</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a string representing the given ::icalparameter_kind. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">kind</td><td>The icalparameter_kind </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A string representing kind</dd></dl>
<dl class="section user"><dt>Error handling</dt><dd>When passed a non-existing ::icalparameter_kind, it returns <code>NULL</code>.</dd></dl>
<dl class="section user"><dt>Ownership</dt><dd>The string that is returned by this function is owned by libical and must not be freed by the caller.</dd></dl>
<h3>Usage</h3>
<div class="fragment"><div class="line">assert(0 == strcmp(<a class="code" href="icalparameter_8h.html#af2bc3ace454dda792d4847dcc919d241">icalparameter_kind_to_string</a>(ICAL_ROLE_PARAMETER), <span class="stringliteral">"ROLE"</span>));</div><div class="line">assert(0 == strcmp(<a class="code" href="icalparameter_8h.html#af2bc3ace454dda792d4847dcc919d241">icalparameter_kind_to_string</a>(ICAL_EMAIL_PARAMETER), <span class="stringliteral">"EMAIL));</span></div><div class="line"><span class="stringliteral">assert(0 == strcmp(icalparameter_kind_to_string(ICAL_ID_PARAMETER), "</span>ID<span class="stringliteral">"));</span></div></div><!-- fragment -->
</div>
</div>
<a id="a2ac8c2694443398bd6253e4a5ab2c3b0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ac8c2694443398bd6253e4a5ab2c3b0">◆ </a></span>icalparameter_new()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">icalparameter* icalparameter_new </td>
<td>(</td>
<td class="paramtype">icalparameter_kind </td>
<td class="paramname"><em>kind</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates new ::icalparameter object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">kind</td><td>The kind of ::icalparameter to create. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An ::icalparameter with the given kind.</dd></dl>
<dl class="section user"><dt>Error handling</dt><dd>If there was an internal error regarding memory allocation, it returns <code>NULL</code> and sets <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a> to <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833a055394ffaf6701aa12491dc10767f07d">ICAL_NEWFAILED_ERROR</a>.</dd></dl>
<dl class="section user"><dt>Ownership</dt><dd>Objects created by this method are owned by the caller and must be released with the <a class="el" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800" title="Frees an ::icalparameter object. ">icalparameter_free()</a> method.</dd></dl>
<h3>Usage</h3>
<div class="fragment"><div class="line"><span class="comment">// create new parameter</span></div><div class="line">icalparameter *parameter = <a class="code" href="icalparameter_8h.html#a2ac8c2694443398bd6253e4a5ab2c3b0">icalparameter_new</a>();</div><div class="line"></div><div class="line"><span class="keywordflow">if</span>(parameter) {</div><div class="line"> <span class="comment">// use parameter ...</span></div><div class="line">}</div><div class="line"></div><div class="line"><span class="comment">// release parameter</span></div><div class="line"><a class="code" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(parameter);</div></div><!-- fragment -->
</div>
</div>
<a id="a560f57eddaa8d43f28a3b9b758563581"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a560f57eddaa8d43f28a3b9b758563581">◆ </a></span>icalparameter_new_clone()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">icalparameter* icalparameter_new_clone </td>
<td>(</td>
<td class="paramtype">icalparameter * </td>
<td class="paramname"><em>p</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates new ::icalparameter as a clone of the given one. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">p</td><td>The existing, non-<code>NULL</code> parameter to clone. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An ::icalparameter that is a clone of the given one.</dd></dl>
<dl class="section user"><dt>Error handling</dt><dd>If <em>p</em> is <code>NULL</code>, it returns <code>NULL</code> and sets <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a> to <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833a2cc8bbcd8c07fc9a16e36f7aae5757b1">ICAL_BADARG_ERROR</a>. If there was an internal error cloning the data, it returns <code>NULL</code> without reporting any error in <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a>.</dd></dl>
<dl class="section user"><dt>Ownership</dt><dd>Objects created by this method are owned by the caller and must be released with the <a class="el" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800" title="Frees an ::icalparameter object. ">icalparameter_free()</a> method.</dd></dl>
<h3>Usage</h3>
<div class="fragment"><div class="line">// create an icalparameter</div><div class="line">icalparameter *param = icalparameter_new_from_string("ROLE=CHAIR");</div><div class="line"></div><div class="line">// clone the parameter</div><div class="line">icalparameter *clone = icalparameter_new_clone(param);</div><div class="line"></div><div class="line">if(clone) {</div><div class="line"> // use clone ...</div><div class="line">}</div><div class="line"></div><div class="line">// release parameters</div><div class="line">icalparameter_free(param);</div><div class="line">icalparameter_free(clone);</div></div><!-- fragment -->
</div>
</div>
<a id="a742e0609475e48232a0e5208184d3767"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a742e0609475e48232a0e5208184d3767">◆ </a></span>icalparameter_new_from_string()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">icalparameter* icalparameter_new_from_string </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create ::icalparameter object from string. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>The string from which to create the ::icalparameter, in the form <code>"PARAMNAME=VALUE"</code> </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An ::icalparameter that corresponds to the given string.</dd></dl>
<dl class="section user"><dt>Error handling</dt><dd>If there was an internal error copying data, it returns <code>NULL</code> and sets <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a> to <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833a055394ffaf6701aa12491dc10767f07d">ICAL_NEWFAILED_ERROR</a>. If <em>value</em> was <code>NULL</code>, it returns <code>NULL</code> and sets <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a> to <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833a2cc8bbcd8c07fc9a16e36f7aae5757b1">ICAL_BADARG_ERROR</a>. If <em>value</em> was malformed, it returns <code>NULL</code> and sets <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a> to <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833a6ba07679ac440358c3090a351d27f0d8">ICAL_MALFORMEDDATA_ERROR</a>.</dd></dl>
<dl class="section user"><dt>Ownership</dt><dd>Objects created by this method are owned by the caller and must be released with the <a class="el" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800" title="Frees an ::icalparameter object. ">icalparameter_free()</a> method.</dd></dl>
<h3>Usage</h3>
<div class="fragment"><div class="line">icalparameter *param = <a class="code" href="icalparameter_8h.html#a742e0609475e48232a0e5208184d3767">icalparameter_new_from_string</a>(<span class="stringliteral">"ROLE=CHAIR"</span>);</div><div class="line"></div><div class="line"><span class="keywordflow">if</span>(param) {</div><div class="line"> <span class="comment">// use param ...</span></div><div class="line">}</div><div class="line"></div><div class="line"><a class="code" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div></div><!-- fragment -->
</div>
</div>
<a id="a6f785010533a0f63de5ef811d7ea0e87"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6f785010533a0f63de5ef811d7ea0e87">◆ </a></span>icalparameter_new_from_value_string()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">icalparameter* icalparameter_new_from_value_string </td>
<td>(</td>
<td class="paramtype">icalparameter_kind </td>
<td class="paramname"><em>kind</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create ::icalparameter of a given <em>kind</em> with a given <em>value</em>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">kind</td><td>The kind of ::icalparameter to create </td></tr>
<tr><td class="paramname">value</td><td>The value of the parameter </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An ::icalparameter with the given kind and value.</dd></dl>
<dl class="section user"><dt>Error handling</dt><dd>If value is <code>NULL</code>, it returns <code>NULL</code> and sets <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a> to <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833a2cc8bbcd8c07fc9a16e36f7aae5757b1">ICAL_BADARG_ERROR</a>.</dd></dl>
<dl class="section user"><dt>Ownership</dt><dd>Objects created by this method are owned by the caller and must be released with the <a class="el" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800" title="Frees an ::icalparameter object. ">icalparameter_free()</a> method.</dd></dl>
<h3>Example</h3>
<div class="fragment"><div class="line"><span class="comment">// create new parameter</span></div><div class="line">icalparameter *param;</div><div class="line">param = <a class="code" href="icalparameter_8h.html#a6f785010533a0f63de5ef811d7ea0e87">icalparameter_new_from_value_string</a>(ICAL_ROLE_PARAMETER, <span class="stringliteral">"CHAIR"</span>);</div><div class="line"></div><div class="line"><span class="comment">// check parameter</span></div><div class="line">assert(0 == strcmp(<a class="code" href="icalparameter_8h.html#aa89e6b3abb7ecc6fece2f56db84e813f">icalparameter_get_iana_name</a>(param), <span class="stringliteral">"ROLE"</span>));</div><div class="line">assert(0 == strcmp(<a class="code" href="icalparameter_8h.html#af315ea93079ce834a1cfd68a67294aab">icalparameter_get_iana_value</a>(param), <span class="stringliteral">"CHAIR"</span>));</div><div class="line"></div><div class="line"><span class="comment">// release memory</span></div><div class="line"><a class="code" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div></div><!-- fragment -->
</div>
</div>
<a id="aab70ecf438e02384a5a13ca6a71e7793"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aab70ecf438e02384a5a13ca6a71e7793">◆ </a></span>icalparameter_set_iana_name()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void icalparameter_set_iana_name </td>
<td>(</td>
<td class="paramtype">icalparameter * </td>
<td class="paramname"><em>param</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>v</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the IANA name of <em>param</em> to <em>v</em>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">param</td><td>The icalparameter to change </td></tr>
<tr><td class="paramname">v</td><td>The IANA name to set <em>param</em> to </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="icalparameter_8h.html#aa89e6b3abb7ecc6fece2f56db84e813f" title="Returns the IANA name of param. ">icalparameter_get_iana_name()</a></dd></dl>
<dl class="section user"><dt>Error handling</dt><dd>If either <em>param</em> or <em>v</em> are <code>NULL</code>, it sets <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a> to ::ICAL_BARARG_ERROR. If there is an error acquiring memory, it sets <code>errno</code> to <code>ENOMEM</code>.</dd></dl>
<dl class="section user"><dt>Ownership</dt><dd>The passed string <em>v</em> stays in the ownership of the caller - libical creates a copy of it.</dd></dl>
<h3>Usage</h3>
<div class="fragment"><div class="line"><span class="comment">// creates new parameter</span></div><div class="line">icalparameter *param = <a class="code" href="icalparameter_8h.html#a2ac8c2694443398bd6253e4a5ab2c3b0">icalparameter_new</a>();</div><div class="line"></div><div class="line"><span class="comment">// sets iana name</span></div><div class="line"><a class="code" href="icalparameter_8h.html#aab70ecf438e02384a5a13ca6a71e7793">icalparameter_set_iana_name</a>(param, <span class="stringliteral">"ROLE"</span>);</div><div class="line"></div><div class="line"><span class="comment">// compare iana name</span></div><div class="line">assert(0 == strcmp(<a class="code" href="icalparameter_8h.html#aa89e6b3abb7ecc6fece2f56db84e813f">icalparameter_get_iana_name</a>(param), <span class="stringliteral">"X-TEST"</span>));</div><div class="line"></div><div class="line"><a class="code" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div></div><!-- fragment -->
</div>
</div>
<a id="adf6329d175597783232853ff1ca53e24"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adf6329d175597783232853ff1ca53e24">◆ </a></span>icalparameter_set_iana_value()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void icalparameter_set_iana_value </td>
<td>(</td>
<td class="paramtype">icalparameter * </td>
<td class="paramname"><em>param</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>v</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the IANA value of <em>param</em> to <em>v</em>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">param</td><td>The ::icalparameter to change </td></tr>
<tr><td class="paramname">v</td><td>The IANA value to set <em>param</em> to </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="icalparameter_8h.html#af315ea93079ce834a1cfd68a67294aab" title="Returns the IANA value of param. ">icalparameter_get_iana_value()</a></dd></dl>
<dl class="section user"><dt>Error handling</dt><dd>If either <em>param</em> or <em>v</em> are <code>NULL</code>, it sets <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a> to ::ICAL_BARARG_ERROR. If there is an error acquiring memory, it sets <code>errno</code> to <code>ENOMEM</code>.</dd></dl>
<dl class="section user"><dt>Ownership</dt><dd>The passed string <em>v</em> stays in the ownership of the caller - libical creates a copy of it.</dd></dl>
<h3>Usage</h3>
<div class="fragment"><div class="line"><span class="comment">// create new parameter</span></div><div class="line">icalparameter *param = <a class="code" href="icalparameter_8h.html#a742e0609475e48232a0e5208184d3767">icalparameter_new_from_string</a>(<span class="stringliteral">"ROLE=ATTENDEE"</span>);</div><div class="line"></div><div class="line"><span class="comment">// set role to chair</span></div><div class="line"><a class="code" href="icalparameter_8h.html#adf6329d175597783232853ff1ca53e24">icalparameter_set_iana_value</a>(param, <span class="stringliteral">"CHAIR"</span>);</div><div class="line"></div><div class="line"><span class="comment">// check that it worked</span></div><div class="line">assert(0 == strcmp(<a class="code" href="icalparameter_8h.html#af315ea93079ce834a1cfd68a67294aab">icalparameter_get_iana_value</a>(param), <span class="stringliteral">"SUCCESS"</span>));</div><div class="line"></div><div class="line"><span class="comment">// release memory</span></div><div class="line"><a class="code" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div></div><!-- fragment -->
</div>
</div>
<a id="a2e77cb0c365e67a65487f916ece223da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2e77cb0c365e67a65487f916ece223da">◆ </a></span>icalparameter_set_xname()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void icalparameter_set_xname </td>
<td>(</td>
<td class="paramtype">icalparameter * </td>
<td class="paramname"><em>param</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>v</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the X-name of <em>param</em> to <em>v</em>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">param</td><td>The ::icalparameter to change </td></tr>
<tr><td class="paramname">v</td><td>The X-name to set <em>param</em> to </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="icalparameter_8h.html#a0e5cea8520c67d68a9f129838a9a6e83" title="Returns the X-name of param. ">icalparameter_get_xname()</a></dd></dl>
<dl class="section user"><dt>Error handling</dt><dd>If either <em>param</em> or <em>v</em> are <code>NULL</code>, it sets <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a> to ::ICAL_BARARG_ERROR. If there is an error acquiring memory, it sets <code>errno</code> to <code>ENOMEM</code>.</dd></dl>
<dl class="section user"><dt>Ownership</dt><dd>The passed string <em>v</em> stays in the ownership of the caller - libical creates a copy of it.</dd></dl>
<h3>Usage</h3>
<div class="fragment"><div class="line"><span class="comment">// creates new parameter</span></div><div class="line">icalparameter *param = <a class="code" href="icalparameter_8h.html#a2ac8c2694443398bd6253e4a5ab2c3b0">icalparameter_new</a>();</div><div class="line"></div><div class="line"><span class="comment">// sets xname</span></div><div class="line"><a class="code" href="icalparameter_8h.html#a2e77cb0c365e67a65487f916ece223da">icalparameter_set_xname</a>(param, <span class="stringliteral">"X-TEST"</span>);</div><div class="line"></div><div class="line"><span class="comment">// compare xname</span></div><div class="line">assert(0 == strcmp(<a class="code" href="icalparameter_8h.html#a0e5cea8520c67d68a9f129838a9a6e83">icalparameter_get_xname</a>(param), <span class="stringliteral">"X-TEST"</span>));</div><div class="line"></div><div class="line"><a class="code" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div></div><!-- fragment -->
</div>
</div>
<a id="aaf0fbf906d011f5af3ce38b626906691"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaf0fbf906d011f5af3ce38b626906691">◆ </a></span>icalparameter_set_xvalue()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void icalparameter_set_xvalue </td>
<td>(</td>
<td class="paramtype">icalparameter * </td>
<td class="paramname"><em>param</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>v</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the X-value of <em>param</em> to <em>v</em>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">param</td><td>The ::icalparameter to change </td></tr>
<tr><td class="paramname">v</td><td>The X-value to set <em>param</em> to </td></tr>
</table>
</dd>
</dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="icalparameter_8h.html#a97de698d7db2cab7c894c67b3d8fb673" title="Returns the X-value of param. ">icalparameter_get_xvalue()</a></dd></dl>
<dl class="section user"><dt>Error handling</dt><dd>If either <em>param</em> or <em>v</em> are <code>NULL</code>, it sets <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value. ">icalerrno</a> to ::ICAL_BARARG_ERROR. If there is an error acquiring memory, it sets <code>errno</code> to <code>ENOMEM</code>.</dd></dl>
<dl class="section user"><dt>Ownership</dt><dd>The passed string <em>v</em> stays in the ownership of the caller - libical creates a copy of it.</dd></dl>
<h3>Usage</h3>
<div class="fragment"><div class="line"><span class="comment">// create new parameter</span></div><div class="line">icalparameter *param = <a class="code" href="icalparameter_8h.html#a742e0609475e48232a0e5208184d3767">icalparameter_new_from_string</a>(<span class="stringliteral">"X-TEST=FAIL"</span>);</div><div class="line"></div><div class="line"><span class="comment">// set test to success</span></div><div class="line"><a class="code" href="icalparameter_8h.html#aaf0fbf906d011f5af3ce38b626906691">icalparameter_set_xvalue</a>(param, <span class="stringliteral">"SUCCESS"</span>);</div><div class="line"></div><div class="line"><span class="comment">// check that it worked</span></div><div class="line">assert(0 == strcmp(<a class="code" href="icalparameter_8h.html#a97de698d7db2cab7c894c67b3d8fb673">icalparameter_get_xvalue</a>(param), <span class="stringliteral">"SUCCESS"</span>));</div><div class="line"></div><div class="line"><span class="comment">// release memory</span></div><div class="line"><a class="code" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div></div><!-- fragment -->
</div>
</div>
<a id="a4e659bfa64d0c6c7cc3da29aadc5d3d6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4e659bfa64d0c6c7cc3da29aadc5d3d6">◆ </a></span>icalparameter_string_to_kind()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">icalparameter_kind icalparameter_string_to_kind </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>string</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the ::icalparameter_kind for a given string. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">string</td><td>A string describing an icalparameter_kind </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>An icalparameter_kind</dd></dl>
<dl class="section user"><dt>Error handling</dt><dd>Returns ::ICAL_NO_PARAMETER if <em>string</em> is <code>NULL</code>. If it can't find the parameter, depending on the ical_get_unknown_token_handling_setting(), it returns either ::ICAL_NO_PARAMETER or ::ICAL_IANA_PARAMETER.</dd></dl>
<dl class="section user"><dt>Ownership</dt><dd>Does not take ownership of <em>string</em>.</dd></dl>
<h3>Usage</h3>
<div class="fragment"><div class="line">assert(<a class="code" href="icalparameter_8h.html#a4e659bfa64d0c6c7cc3da29aadc5d3d6">icalparameter_string_to_kind</a>(<span class="stringliteral">"ROLE"</span>) == ICAL_ROLE_PARAMETER);</div><div class="line">assert(<a class="code" href="icalparameter_8h.html#a4e659bfa64d0c6c7cc3da29aadc5d3d6">icalparameter_string_to_kind</a>(<span class="stringliteral">"EMAIL"</span>) == ICAL_EMAIL_PARAMETER);</div><div class="line">assert(<a class="code" href="icalparameter_8h.html#a4e659bfa64d0c6c7cc3da29aadc5d3d6">icalparameter_string_to_kind</a>(<span class="stringliteral">"ID"</span>) == ICAL_ID_PARAMETER);</div></div><!-- fragment -->
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
|
