summaryrefslogtreecommitdiff
path: root/apidocs/icalparameter_8h.html
diff options
context:
space:
mode:
Diffstat (limited to 'apidocs/icalparameter_8h.html')
-rw-r--r--apidocs/icalparameter_8h.html126
1 files changed, 54 insertions, 72 deletions
diff --git a/apidocs/icalparameter_8h.html b/apidocs/icalparameter_8h.html
index 3ef1cd44..77ebf2b2 100644
--- a/apidocs/icalparameter_8h.html
+++ b/apidocs/icalparameter_8h.html
@@ -1,9 +1,9 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.14"/>
+<meta name="generator" content="Doxygen 1.8.15"/>
<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"/>
@@ -30,7 +30,7 @@
</table>
</div>
<!-- end header part -->
-<!-- Generated by Doxygen 1.8.14 -->
+<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
@@ -166,11 +166,10 @@ Functions</h2></td></tr>
</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">&quot;ROLE=CHAIR&quot;</span>);</div><div class="line"></div><div class="line"><span class="keywordflow">if</span>(param) {</div><div class="line"> printf(<span class="stringliteral">&quot;%s\n&quot;</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 -->
+<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>
+<p>### Usage </p><div class="fragment"><div class="line">icalparameter *param = <a class="code" href="icalparameter_8h.html#a742e0609475e48232a0e5208184d3767">icalparameter_new_from_string</a>(<span class="stringliteral">&quot;ROLE=CHAIR&quot;</span>);</div><div class="line"></div><div class="line"><span class="keywordflow">if</span>(param) {</div><div class="line"> printf(<span class="stringliteral">&quot;%s\n&quot;</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>
@@ -197,11 +196,10 @@ Functions</h2></td></tr>
</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">&quot;ROLE=CHAIR&quot;</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">&quot;%s\n&quot;</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>
+<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>
+<p>### Usage </p><div class="fragment"><div class="line">icalparameter *param = <a class="code" href="icalparameter_8h.html#a742e0609475e48232a0e5208184d3767">icalparameter_new_from_string</a>(<span class="stringliteral">&quot;ROLE=CHAIR&quot;</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">&quot;%s\n&quot;</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>
@@ -229,9 +227,8 @@ Functions</h2></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 -->
+<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>
+<p>### Usage </p><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>
@@ -258,11 +255,10 @@ Functions</h2></td></tr>
</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 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">&quot;X-TEST&quot;</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">&quot;X-TEST&quot;</span>));</div><div class="line"></div><div class="line"><a class="code" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div></div><!-- fragment -->
+<p>### Usage </p><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">&quot;X-TEST&quot;</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">&quot;X-TEST&quot;</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>
@@ -289,11 +285,10 @@ Functions</h2></td></tr>
</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 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">&quot;ROLE=ATTENDEE&quot;</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">&quot;CHAIR&quot;</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">&quot;SUCCESS&quot;</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 -->
+<p>### Usage </p><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">&quot;ROLE=ATTENDEE&quot;</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">&quot;CHAIR&quot;</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">&quot;SUCCESS&quot;</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>
@@ -320,11 +315,10 @@ Functions</h2></td></tr>
</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 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">&quot;X-TEST&quot;</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">&quot;X-TEST&quot;</span>));</div><div class="line"></div><div class="line"><a class="code" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div></div><!-- fragment -->
+<p>### Usage </p><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">&quot;X-TEST&quot;</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">&quot;X-TEST&quot;</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>
@@ -351,11 +345,10 @@ Functions</h2></td></tr>
</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 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">&quot;X-TEST=FAIL&quot;</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">&quot;SUCCESS&quot;</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">&quot;SUCCESS&quot;</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 -->
+<p>### Usage </p><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">&quot;X-TEST=FAIL&quot;</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">&quot;SUCCESS&quot;</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">&quot;SUCCESS&quot;</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>
@@ -393,10 +386,9 @@ Functions</h2></td></tr>
</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>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">&quot;ROLE=CHAIR&quot;</span>);</div><div class="line">icalparameter *param2 = <a class="code" href="icalparameter_8h.html#a742e0609475e48232a0e5208184d3767">icalparameter_new_from_string</a>(<span class="stringliteral">&quot;EMAIL=mailto@example.com&quot;</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 -->
+<p>### Example </p><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">&quot;ROLE=CHAIR&quot;</span>);</div><div class="line">icalparameter *param2 = <a class="code" href="icalparameter_8h.html#a742e0609475e48232a0e5208184d3767">icalparameter_new_from_string</a>(<span class="stringliteral">&quot;EMAIL=mailto@example.com&quot;</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>
@@ -507,8 +499,7 @@ Functions</h2></td></tr>
<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">&quot;ROLE&quot;</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">&quot;EMAIL));</span></div><div class="line"><span class="stringliteral">assert(0 == strcmp(icalparameter_kind_to_string(ICAL_ID_PARAMETER), &quot;</span>ID<span class="stringliteral">&quot;));</span></div></div><!-- fragment -->
+<p>### Usage </p><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">&quot;ROLE&quot;</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">&quot;EMAIL));</span></div><div class="line"><span class="stringliteral">assert(0 == strcmp(icalparameter_kind_to_string(ICAL_ID_PARAMETER), &quot;</span>ID<span class="stringliteral">&quot;));</span></div></div><!-- fragment -->
</div>
</div>
<a id="a2ac8c2694443398bd6253e4a5ab2c3b0"></a>
@@ -535,10 +526,9 @@ Functions</h2></td></tr>
</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 -->
+<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>
+<p>### Usage </p><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>
@@ -565,10 +555,9 @@ Functions</h2></td></tr>
</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(&quot;ROLE=CHAIR&quot;);</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 -->
+<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>
+<p>### Usage </p><div class="fragment"><div class="line">// create an icalparameter</div><div class="line">icalparameter *param = icalparameter_new_from_string(&quot;ROLE=CHAIR&quot;);</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>
@@ -595,10 +584,9 @@ Functions</h2></td></tr>
</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">&quot;ROLE=CHAIR&quot;</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 -->
+<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>
+<p>### Usage </p><div class="fragment"><div class="line">icalparameter *param = <a class="code" href="icalparameter_8h.html#a742e0609475e48232a0e5208184d3767">icalparameter_new_from_string</a>(<span class="stringliteral">&quot;ROLE=CHAIR&quot;</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>
@@ -636,10 +624,9 @@ Functions</h2></td></tr>
</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">&quot;CHAIR&quot;</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">&quot;ROLE&quot;</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">&quot;CHAIR&quot;</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 -->
+<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>
+<p>### Example </p><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">&quot;CHAIR&quot;</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">&quot;ROLE&quot;</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">&quot;CHAIR&quot;</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>
@@ -676,11 +663,10 @@ Functions</h2></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 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">&quot;ROLE&quot;</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">&quot;X-TEST&quot;</span>));</div><div class="line"></div><div class="line"><a class="code" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div></div><!-- fragment -->
+<p>### Usage </p><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">&quot;ROLE&quot;</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">&quot;X-TEST&quot;</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>
@@ -717,11 +703,10 @@ Functions</h2></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 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">&quot;ROLE=ATTENDEE&quot;</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">&quot;CHAIR&quot;</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">&quot;SUCCESS&quot;</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 -->
+<p>### Usage </p><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">&quot;ROLE=ATTENDEE&quot;</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">&quot;CHAIR&quot;</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">&quot;SUCCESS&quot;</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>
@@ -758,11 +743,10 @@ Functions</h2></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 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">&quot;X-TEST&quot;</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">&quot;X-TEST&quot;</span>));</div><div class="line"></div><div class="line"><a class="code" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div></div><!-- fragment -->
+<p>### Usage </p><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">&quot;X-TEST&quot;</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">&quot;X-TEST&quot;</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>
@@ -799,11 +783,10 @@ Functions</h2></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 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">&quot;X-TEST=FAIL&quot;</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">&quot;SUCCESS&quot;</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">&quot;SUCCESS&quot;</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 -->
+<p>### Usage </p><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">&quot;X-TEST=FAIL&quot;</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">&quot;SUCCESS&quot;</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">&quot;SUCCESS&quot;</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>
@@ -832,8 +815,7 @@ Functions</h2></td></tr>
<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">&quot;ROLE&quot;</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">&quot;EMAIL&quot;</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">&quot;ID&quot;</span>) == ICAL_ID_PARAMETER);</div></div><!-- fragment -->
+<p>### Usage </p><div class="fragment"><div class="line">assert(<a class="code" href="icalparameter_8h.html#a4e659bfa64d0c6c7cc3da29aadc5d3d6">icalparameter_string_to_kind</a>(<span class="stringliteral">&quot;ROLE&quot;</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">&quot;EMAIL&quot;</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">&quot;ID&quot;</span>) == ICAL_ID_PARAMETER);</div></div><!-- fragment -->
</div>
</div>
</div><!-- contents -->
@@ -841,7 +823,7 @@ Functions</h2></td></tr>
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
-</a> 1.8.14
+</a> 1.8.15
</small></address>
</body>
</html>