diff options
| author | Allen Winter <allen.winter@kdab.com> | 2022-10-06 14:47:43 -0400 |
|---|---|---|
| committer | Allen Winter <allen.winter@kdab.com> | 2022-10-06 14:47:43 -0400 |
| commit | 89a67caf2c463900bf0d8fa552b21e5ac4bf0f78 (patch) | |
| tree | 85248809364062d4e325660c1ed2efc82492b9d6 /apidocs/icalparameter_8h.html | |
| parent | d428294888871b513716279103fed26f920924e8 (diff) | |
| download | libical-git-gh-pages.tar.gz | |
update apidoxgh-pages
Diffstat (limited to 'apidocs/icalparameter_8h.html')
| -rw-r--r-- | apidocs/icalparameter_8h.html | 427 |
1 files changed, 189 insertions, 238 deletions
diff --git a/apidocs/icalparameter_8h.html b/apidocs/icalparameter_8h.html index 5a1d7752..58e21379 100644 --- a/apidocs/icalparameter_8h.html +++ b/apidocs/icalparameter_8h.html @@ -2,8 +2,8 @@ <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=11"/> -<meta name="generator" content="Doxygen 1.9.3"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen 1.9.1"/> <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"/> @@ -19,9 +19,10 @@ <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> - <tr id="projectrow"> - <td id="projectalign"> - <div id="projectname">Libical API Documentation<span id="projectnumber"> 3.1</span> + <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> @@ -29,22 +30,21 @@ </table> </div> <!-- end header part --> -<!-- Generated by Doxygen 1.9.3 --> +<!-- Generated by Doxygen 1.9.1 --> <script type="text/javascript"> -/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ -var searchBox = new SearchBox("searchBox", "search",'Search','.html'); +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +var searchBox = new SearchBox("searchBox", "search",false,'Search','.html'); /* @license-end */ </script> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> -/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ +/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('',true,false,'search.php','Search'); $(document).ready(function() { init_search(); }); }); -/* @license-end */ -</script> +/* @license-end */</script> <div id="main-nav"></div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" @@ -68,38 +68,36 @@ $(function() { <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 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 id="func-members" name="func-members"></a> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> Functions</h2></td></tr> -<tr class="memitem:ab8222d0c7236fee6e6ae47a79955db45"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparameter_8h.html#ab8222d0c7236fee6e6ae47a79955db45">icalparameter_as_ical_string</a> (icalparameter *parameter)</td></tr> -<tr class="memdesc:ab8222d0c7236fee6e6ae47a79955db45"><td class="mdescLeft"> </td><td class="mdescRight">Converts icalparameter into a string representation. <a href="icalparameter_8h.html#ab8222d0c7236fee6e6ae47a79955db45">More...</a><br /></td></tr> -<tr class="separator:ab8222d0c7236fee6e6ae47a79955db45"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:afe13c2029af7332593df37d1ebbd8b3c"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparameter_8h.html#afe13c2029af7332593df37d1ebbd8b3c">icalparameter_as_ical_string_r</a> (icalparameter *parameter)</td></tr> -<tr class="memdesc:afe13c2029af7332593df37d1ebbd8b3c"><td class="mdescLeft"> </td><td class="mdescRight">Converts icalparameter into an string representation according to RFC5445/RFC6868. <a href="icalparameter_8h.html#afe13c2029af7332593df37d1ebbd8b3c">More...</a><br /></td></tr> -<tr class="separator:afe13c2029af7332593df37d1ebbd8b3c"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a736a5b4f88c51ba730fddb29981c57de"><td class="memItemLeft" align="right" valign="top">icalparameter * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparameter_8h.html#a736a5b4f88c51ba730fddb29981c57de">icalparameter_clone</a> (const icalparameter *p)</td></tr> -<tr class="memdesc:a736a5b4f88c51ba730fddb29981c57de"><td class="mdescLeft"> </td><td class="mdescRight">Creates new icalparameter as a clone of the given one. <a href="icalparameter_8h.html#a736a5b4f88c51ba730fddb29981c57de">More...</a><br /></td></tr> -<tr class="separator:a736a5b4f88c51ba730fddb29981c57de"><td class="memSeparator" colspan="2"> </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">Converts icalparameter into a string representation. <a href="icalparameter_8h.html#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">Converts icalparameter into an string representation according to RFC5445/RFC6868. <a href="icalparameter_8h.html#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="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">More...</a><br /></td></tr> <tr class="separator:aafadb9fd4172bab0d17252d251c69800"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ab644f9bab546eea75306f349914af05a"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparameter_8h.html#ab644f9bab546eea75306f349914af05a">icalparameter_get_iana_name</a> (icalparameter *param)</td></tr> -<tr class="memdesc:ab644f9bab546eea75306f349914af05a"><td class="mdescLeft"> </td><td class="mdescRight">Returns the IANA name of <em>param</em>. <a href="icalparameter_8h.html#ab644f9bab546eea75306f349914af05a">More...</a><br /></td></tr> -<tr class="separator:ab644f9bab546eea75306f349914af05a"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a93de301878e702d08cf89dae83c071f7"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparameter_8h.html#a93de301878e702d08cf89dae83c071f7">icalparameter_get_iana_value</a> (icalparameter *param)</td></tr> -<tr class="memdesc:a93de301878e702d08cf89dae83c071f7"><td class="mdescLeft"> </td><td class="mdescRight">Returns the IANA value of <em>param</em>. <a href="icalparameter_8h.html#a93de301878e702d08cf89dae83c071f7">More...</a><br /></td></tr> -<tr class="separator:a93de301878e702d08cf89dae83c071f7"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a28c4415b82455f7551aa4c48b36be438"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparameter_8h.html#a28c4415b82455f7551aa4c48b36be438">icalparameter_get_xname</a> (icalparameter *param)</td></tr> -<tr class="memdesc:a28c4415b82455f7551aa4c48b36be438"><td class="mdescLeft"> </td><td class="mdescRight">Returns the X-name of <em>param</em>. <a href="icalparameter_8h.html#a28c4415b82455f7551aa4c48b36be438">More...</a><br /></td></tr> -<tr class="separator:a28c4415b82455f7551aa4c48b36be438"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a1e2ee9baea3213f18d2b93cdf3892c72"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparameter_8h.html#a1e2ee9baea3213f18d2b93cdf3892c72">icalparameter_get_xvalue</a> (icalparameter *param)</td></tr> -<tr class="memdesc:a1e2ee9baea3213f18d2b93cdf3892c72"><td class="mdescLeft"> </td><td class="mdescRight">Returns the X-value of <em>param</em>. <a href="icalparameter_8h.html#a1e2ee9baea3213f18d2b93cdf3892c72">More...</a><br /></td></tr> -<tr class="separator:a1e2ee9baea3213f18d2b93cdf3892c72"><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="icalparameter_8h.html#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="icalparameter_8h.html#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="icalparameter_8h.html#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="icalparameter_8h.html#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="icalparameter_8h.html#add735467f8a84b476f5899e262a072a2">More...</a><br /></td></tr> <tr class="separator:add735467f8a84b476f5899e262a072a2"><td class="memSeparator" colspan="2"> </td></tr> @@ -110,21 +108,21 @@ Functions</h2></td></tr> <tr class="memitem:a236331311b5c8957e718f6abb205fb66"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparameter_8h.html#a236331311b5c8957e718f6abb205fb66">icalparameter_kind_is_valid</a> (const icalparameter_kind kind)</td></tr> <tr class="memdesc:a236331311b5c8957e718f6abb205fb66"><td class="mdescLeft"> </td><td class="mdescRight">Checks the validity of a icalparameter_kind. <a href="icalparameter_8h.html#a236331311b5c8957e718f6abb205fb66">More...</a><br /></td></tr> <tr class="separator:a236331311b5c8957e718f6abb205fb66"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a6a172a9cc1bc5cc1315f96e6cad70438"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparameter_8h.html#a6a172a9cc1bc5cc1315f96e6cad70438">icalparameter_kind_to_string</a> (icalparameter_kind kind)</td></tr> -<tr class="memdesc:a6a172a9cc1bc5cc1315f96e6cad70438"><td class="mdescLeft"> </td><td class="mdescRight">Returns a string representing the given icalparameter_kind. <a href="icalparameter_8h.html#a6a172a9cc1bc5cc1315f96e6cad70438">More...</a><br /></td></tr> -<tr class="separator:a6a172a9cc1bc5cc1315f96e6cad70438"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a252cdad9d54b31b898ff273ce5439429"><td class="memItemLeft" align="right" valign="top">icalparameter * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparameter_8h.html#a252cdad9d54b31b898ff273ce5439429">icalparameter_new</a> (icalparameter_kind kind)</td></tr> -<tr class="memdesc:a252cdad9d54b31b898ff273ce5439429"><td class="mdescLeft"> </td><td class="mdescRight">Creates new icalparameter object. <a href="icalparameter_8h.html#a252cdad9d54b31b898ff273ce5439429">More...</a><br /></td></tr> -<tr class="separator:a252cdad9d54b31b898ff273ce5439429"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a913f1e9184b211c0c59a7b36e2710264"><td class="memItemLeft" align="right" valign="top">icalparameter * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparameter_8h.html#a913f1e9184b211c0c59a7b36e2710264">icalparameter_new_clone</a> (icalparameter *p))</td></tr> -<tr class="memdesc:a913f1e9184b211c0c59a7b36e2710264"><td class="mdescLeft"> </td><td class="mdescRight">Creates new icalparameter as a clone of the given one. <a href="icalparameter_8h.html#a913f1e9184b211c0c59a7b36e2710264">More...</a><br /></td></tr> -<tr class="separator:a913f1e9184b211c0c59a7b36e2710264"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:aa3f2cce04d344d002ca83e797c05dd8b"><td class="memItemLeft" align="right" valign="top">icalparameter * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparameter_8h.html#aa3f2cce04d344d002ca83e797c05dd8b">icalparameter_new_from_string</a> (const char *value)</td></tr> -<tr class="memdesc:aa3f2cce04d344d002ca83e797c05dd8b"><td class="mdescLeft"> </td><td class="mdescRight">Creates new icalparameter object from string. <a href="icalparameter_8h.html#aa3f2cce04d344d002ca83e797c05dd8b">More...</a><br /></td></tr> -<tr class="separator:aa3f2cce04d344d002ca83e797c05dd8b"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:abe33daa839d72261aab283d0f44f711f"><td class="memItemLeft" align="right" valign="top">icalparameter * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalparameter_8h.html#abe33daa839d72261aab283d0f44f711f">icalparameter_new_from_value_string</a> (icalparameter_kind kind, const char *value)</td></tr> -<tr class="memdesc:abe33daa839d72261aab283d0f44f711f"><td class="mdescLeft"> </td><td class="mdescRight">Creates new icalparameter of a given <em>kind</em> with a given <em>value</em>. <a href="icalparameter_8h.html#abe33daa839d72261aab283d0f44f711f">More...</a><br /></td></tr> -<tr class="separator:abe33daa839d72261aab283d0f44f711f"><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="icalparameter_8h.html#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="icalparameter_8h.html#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="icalparameter_8h.html#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">Creates new icalparameter object from string. <a href="icalparameter_8h.html#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">Creates new icalparameter of a given <em>kind</em> with a given <em>value</em>. <a href="icalparameter_8h.html#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="icalparameter_8h.html#aab70ecf438e02384a5a13ca6a71e7793">More...</a><br /></td></tr> <tr class="separator:aab70ecf438e02384a5a13ca6a71e7793"><td class="memSeparator" colspan="2"> </td></tr> @@ -142,16 +140,16 @@ Functions</h2></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 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="ab8222d0c7236fee6e6ae47a79955db45" name="ab8222d0c7236fee6e6ae47a79955db45"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ab8222d0c7236fee6e6ae47a79955db45">◆ </a></span>icalparameter_as_ical_string()</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 class="memname">char* icalparameter_as_ical_string </td> <td>(</td> <td class="paramtype">icalparameter * </td> <td class="paramname"><em>parameter</em></td><td>)</td> @@ -168,31 +166,31 @@ 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#afe13c2029af7332593df37d1ebbd8b3c" title="Converts icalparameter into an string representation according to RFC5445/RFC6868.">icalparameter_as_ical_string_r()</a></dd></dl> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="icalparameter_8h.html#adfc8b22df1d5ead58b47fd83b772c9b0" title="Converts icalparameter into an string representation according to RFC5445/RFC6868.">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#afe13c2029af7332593df37d1ebbd8b3c" title="Converts icalparameter into an string representation according to RFC5445/RFC6868.">icalparameter_as_ical_string_r()</a>.</dd></dl> -<dl class="section user"><dt>Usage</dt><dd><div class="fragment"><div class="line">icalparameter *param = <a class="code hl_function" href="icalparameter_8h.html#aa3f2cce04d344d002ca83e797c05dd8b">icalparameter_new_from_string</a>(<span class="stringliteral">"ROLE=CHAIR"</span>);</div> +<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="Converts icalparameter into an string representation according to RFC5445/RFC6868.">icalparameter_as_ical_string_r()</a>.</dd></dl> +<dl class="section user"><dt>Usage</dt><dd><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 hl_function" href="icalparameter_8h.html#ab8222d0c7236fee6e6ae47a79955db45">icalparameter_as_ical_string</a>(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 hl_function" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div> -<div class="ttc" id="aicalparameter_8h_html_aa3f2cce04d344d002ca83e797c05dd8b"><div class="ttname"><a href="icalparameter_8h.html#aa3f2cce04d344d002ca83e797c05dd8b">icalparameter_new_from_string</a></div><div class="ttdeci">icalparameter * icalparameter_new_from_string(const char *value)</div><div class="ttdoc">Creates new icalparameter object from string.</div><div class="ttdef"><b>Definition:</b> icalparameter.c:115</div></div> -<div class="ttc" id="aicalparameter_8h_html_aafadb9fd4172bab0d17252d251c69800"><div class="ttname"><a href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a></div><div class="ttdeci">void icalparameter_free(icalparameter *parameter)</div><div class="ttdoc">Frees an icalparameter object.</div><div class="ttdef"><b>Definition:</b> icalparameter.c:51</div></div> -<div class="ttc" id="aicalparameter_8h_html_ab8222d0c7236fee6e6ae47a79955db45"><div class="ttname"><a href="icalparameter_8h.html#ab8222d0c7236fee6e6ae47a79955db45">icalparameter_as_ical_string</a></div><div class="ttdeci">char * icalparameter_as_ical_string(icalparameter *parameter)</div><div class="ttdoc">Converts icalparameter into a string representation.</div><div class="ttdef"><b>Definition:</b> icalparameter.c:164</div></div> +<div class="line"><a class="code" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div> +<div class="ttc" id="aicalparameter_8h_html_a742e0609475e48232a0e5208184d3767"><div class="ttname"><a href="icalparameter_8h.html#a742e0609475e48232a0e5208184d3767">icalparameter_new_from_string</a></div><div class="ttdeci">icalparameter * icalparameter_new_from_string(const char *value)</div><div class="ttdoc">Creates new icalparameter object from string.</div><div class="ttdef"><b>Definition:</b> icalparameter.c:119</div></div> +<div class="ttc" id="aicalparameter_8h_html_aafadb9fd4172bab0d17252d251c69800"><div class="ttname"><a href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a></div><div class="ttdeci">void icalparameter_free(icalparameter *parameter)</div><div class="ttdoc">Frees an icalparameter object.</div><div class="ttdef"><b>Definition:</b> icalparameter.c:60</div></div> +<div class="ttc" id="aicalparameter_8h_html_adca99971f21bcb7259f54c524837003e"><div class="ttname"><a href="icalparameter_8h.html#adca99971f21bcb7259f54c524837003e">icalparameter_as_ical_string</a></div><div class="ttdeci">char * icalparameter_as_ical_string(icalparameter *parameter)</div><div class="ttdoc">Converts icalparameter into a string representation.</div><div class="ttdef"><b>Definition:</b> icalparameter.c:168</div></div> </div><!-- fragment --> </dd></dl> </div> </div> -<a id="afe13c2029af7332593df37d1ebbd8b3c" name="afe13c2029af7332593df37d1ebbd8b3c"></a> -<h2 class="memtitle"><span class="permalink"><a href="#afe13c2029af7332593df37d1ebbd8b3c">◆ </a></span>icalparameter_as_ical_string_r()</h2> +<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 class="memname">char* icalparameter_as_ical_string_r </td> <td>(</td> <td class="paramtype">icalparameter * </td> <td class="paramname"><em>parameter</em></td><td>)</td> @@ -209,68 +207,23 @@ Functions</h2></td></tr> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>A string representing the parameter </dd></dl> -<dl class="section see"><dt>See also</dt><dd><a class="el" href="icalparameter_8h.html#ab8222d0c7236fee6e6ae47a79955db45" title="Converts icalparameter into a string representation.">icalparameter_as_ical_string()</a></dd></dl> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="icalparameter_8h.html#adca99971f21bcb7259f54c524837003e" title="Converts icalparameter into a 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><a class="el" href="icalmemory_8h.html#a2f164cb87c67f06b5dc04a5f21384879" title="Releases a buffer.">icalmemory_free_buffer()</a></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#ab8222d0c7236fee6e6ae47a79955db45" title="Converts icalparameter into a string representation.">icalparameter_as_ical_string()</a>.</dd></dl> -<dl class="section user"><dt>Usage</dt><dd><div class="fragment"><div class="line">icalparameter *param = <a class="code hl_function" href="icalparameter_8h.html#aa3f2cce04d344d002ca83e797c05dd8b">icalparameter_new_from_string</a>(<span class="stringliteral">"ROLE=CHAIR"</span>);</div> +<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="Converts icalparameter into a string representation.">icalparameter_as_ical_string()</a>.</dd></dl> +<dl class="section user"><dt>Usage</dt><dd><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 hl_function" href="icalparameter_8h.html#ab8222d0c7236fee6e6ae47a79955db45">icalparameter_as_ical_string</a>(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"> <a class="code hl_function" href="icalmemory_8h.html#a2f164cb87c67f06b5dc04a5f21384879">icalmemory_free_buffer</a>(str);</div> -<div class="line">}</div> -<div class="line"> </div> -<div class="line"><a class="code hl_function" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div> -<div class="ttc" id="aicalmemory_8h_html_a2f164cb87c67f06b5dc04a5f21384879"><div class="ttname"><a href="icalmemory_8h.html#a2f164cb87c67f06b5dc04a5f21384879">icalmemory_free_buffer</a></div><div class="ttdeci">void icalmemory_free_buffer(void *buf)</div><div class="ttdoc">Releases a buffer.</div><div class="ttdef"><b>Definition:</b> icalmemory.c:359</div></div> -</div><!-- fragment --> </dd></dl> - -</div> -</div> -<a id="a736a5b4f88c51ba730fddb29981c57de" name="a736a5b4f88c51ba730fddb29981c57de"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a736a5b4f88c51ba730fddb29981c57de">◆ </a></span>icalparameter_clone()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">icalparameter * icalparameter_clone </td> - <td>(</td> - <td class="paramtype">const 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> -<dl class="section user"><dt>Usage</dt><dd><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_clone(param);</div> -<div class="line"> </div> -<div class="line">if(clone) {</div> -<div class="line"> // use clone ...</div> +<div class="line"> free(str);</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 class="line"><a class="code" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div> </div><!-- fragment --> </dd></dl> -<dl class="section since"><dt>Since</dt><dd>3.1.0 </dd></dl> </div> </div> -<a id="aafadb9fd4172bab0d17252d251c69800" name="aafadb9fd4172bab0d17252d251c69800"></a> +<a id="aafadb9fd4172bab0d17252d251c69800"></a> <h2 class="memtitle"><span class="permalink"><a href="#aafadb9fd4172bab0d17252d251c69800">◆ </a></span>icalparameter_free()</h2> <div class="memitem"> @@ -293,28 +246,28 @@ 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#a252cdad9d54b31b898ff273ce5439429" title="Creates new icalparameter object.">icalparameter_new()</a>, <a class="el" href="icalparameter_8h.html#aa3f2cce04d344d002ca83e797c05dd8b" title="Creates new icalparameter object from string.">icalparameter_new_from_string()</a> and <a class="el" href="icalparameter_8h.html#abe33daa839d72261aab283d0f44f711f" title="Creates new icalparameter of a given kind with a given value.">icalparameter_new_from_value_string()</a> and on cloned parameter objects returned by <a class="el" href="icalparameter_8h.html#a736a5b4f88c51ba730fddb29981c57de" title="Creates new icalparameter as a clone of the given one.">icalparameter_clone()</a> when these object are not needed anymore and to be released.</p> -<dl class="section user"><dt>Usage</dt><dd><div class="fragment"><div class="line">icalparameter *param = <a class="code hl_function" href="icalparameter_8h.html#a252cdad9d54b31b898ff273ce5439429">icalparameter_new</a>();</div> +<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="Creates new icalparameter object from string.">icalparameter_new_from_string()</a> and <a class="el" href="icalparameter_8h.html#a6f785010533a0f63de5ef811d7ea0e87" title="Creates new 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> +<dl class="section user"><dt>Usage</dt><dd><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 hl_function" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div> -<div class="ttc" id="aicalparameter_8h_html_a252cdad9d54b31b898ff273ce5439429"><div class="ttname"><a href="icalparameter_8h.html#a252cdad9d54b31b898ff273ce5439429">icalparameter_new</a></div><div class="ttdeci">icalparameter * icalparameter_new(icalparameter_kind kind)</div><div class="ttdoc">Creates new icalparameter object.</div><div class="ttdef"><b>Definition:</b> icalparameter.c:44</div></div> +<div class="line"><a class="code" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div> +<div class="ttc" id="aicalparameter_8h_html_a2ac8c2694443398bd6253e4a5ab2c3b0"><div class="ttname"><a href="icalparameter_8h.html#a2ac8c2694443398bd6253e4a5ab2c3b0">icalparameter_new</a></div><div class="ttdeci">icalparameter * icalparameter_new(icalparameter_kind kind)</div><div class="ttdoc">Creates new icalparameter object.</div><div class="ttdef"><b>Definition:</b> icalparameter.c:53</div></div> </div><!-- fragment --> </dd></dl> </div> </div> -<a id="ab644f9bab546eea75306f349914af05a" name="ab644f9bab546eea75306f349914af05a"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ab644f9bab546eea75306f349914af05a">◆ </a></span>icalparameter_get_iana_name()</h2> +<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 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> @@ -335,29 +288,29 @@ Functions</h2></td></tr> <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> <dl class="section user"><dt>Usage</dt><dd><div class="fragment"><div class="line"><span class="comment">// creates new parameter</span></div> -<div class="line">icalparameter *param = <a class="code hl_function" href="icalparameter_8h.html#a252cdad9d54b31b898ff273ce5439429">icalparameter_new</a>();</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 hl_function" href="icalparameter_8h.html#aab70ecf438e02384a5a13ca6a71e7793">icalparameter_set_iana_name</a>(param, <span class="stringliteral">"X-TEST"</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 hl_function" href="icalparameter_8h.html#ab644f9bab546eea75306f349914af05a">icalparameter_get_iana_name</a>(param), <span class="stringliteral">"X-TEST"</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 hl_function" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div> -<div class="ttc" id="aicalparameter_8h_html_aab70ecf438e02384a5a13ca6a71e7793"><div class="ttname"><a href="icalparameter_8h.html#aab70ecf438e02384a5a13ca6a71e7793">icalparameter_set_iana_name</a></div><div class="ttdeci">void icalparameter_set_iana_name(icalparameter *param, const char *v)</div><div class="ttdoc">Sets the IANA name of param to v.</div><div class="ttdef"><b>Definition:</b> icalparameter.c:396</div></div> -<div class="ttc" id="aicalparameter_8h_html_ab644f9bab546eea75306f349914af05a"><div class="ttname"><a href="icalparameter_8h.html#ab644f9bab546eea75306f349914af05a">icalparameter_get_iana_name</a></div><div class="ttdeci">const char * icalparameter_get_iana_name(icalparameter *param)</div><div class="ttdoc">Returns the IANA name of param.</div><div class="ttdef"><b>Definition:</b> icalparameter.c:401</div></div> +<div class="line"><a class="code" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div> +<div class="ttc" id="aicalparameter_8h_html_aa89e6b3abb7ecc6fece2f56db84e813f"><div class="ttname"><a href="icalparameter_8h.html#aa89e6b3abb7ecc6fece2f56db84e813f">icalparameter_get_iana_name</a></div><div class="ttdeci">const char * icalparameter_get_iana_name(icalparameter *param)</div><div class="ttdoc">Returns the IANA name of param.</div><div class="ttdef"><b>Definition:</b> icalparameter.c:405</div></div> +<div class="ttc" id="aicalparameter_8h_html_aab70ecf438e02384a5a13ca6a71e7793"><div class="ttname"><a href="icalparameter_8h.html#aab70ecf438e02384a5a13ca6a71e7793">icalparameter_set_iana_name</a></div><div class="ttdeci">void icalparameter_set_iana_name(icalparameter *param, const char *v)</div><div class="ttdoc">Sets the IANA name of param to v.</div><div class="ttdef"><b>Definition:</b> icalparameter.c:400</div></div> </div><!-- fragment --> </dd></dl> </div> </div> -<a id="a93de301878e702d08cf89dae83c071f7" name="a93de301878e702d08cf89dae83c071f7"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a93de301878e702d08cf89dae83c071f7">◆ </a></span>icalparameter_get_iana_value()</h2> +<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 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> @@ -378,30 +331,30 @@ Functions</h2></td></tr> <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> <dl class="section user"><dt>Usage</dt><dd><div class="fragment"><div class="line"><span class="comment">// create new parameter</span></div> -<div class="line">icalparameter *param = <a class="code hl_function" href="icalparameter_8h.html#aa3f2cce04d344d002ca83e797c05dd8b">icalparameter_new_from_string</a>(<span class="stringliteral">"ROLE=ATTENDEE"</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 hl_function" href="icalparameter_8h.html#adf6329d175597783232853ff1ca53e24">icalparameter_set_iana_value</a>(param, <span class="stringliteral">"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 hl_function" href="icalparameter_8h.html#a93de301878e702d08cf89dae83c071f7">icalparameter_get_iana_value</a>(param), <span class="stringliteral">"SUCCESS"</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 hl_function" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div> -<div class="ttc" id="aicalparameter_8h_html_a93de301878e702d08cf89dae83c071f7"><div class="ttname"><a href="icalparameter_8h.html#a93de301878e702d08cf89dae83c071f7">icalparameter_get_iana_value</a></div><div class="ttdeci">const char * icalparameter_get_iana_value(icalparameter *param)</div><div class="ttdoc">Returns the IANA value of param.</div><div class="ttdef"><b>Definition:</b> icalparameter.c:391</div></div> -<div class="ttc" id="aicalparameter_8h_html_adf6329d175597783232853ff1ca53e24"><div class="ttname"><a href="icalparameter_8h.html#adf6329d175597783232853ff1ca53e24">icalparameter_set_iana_value</a></div><div class="ttdeci">void icalparameter_set_iana_value(icalparameter *param, const char *v)</div><div class="ttdoc">Sets the IANA value of param to v.</div><div class="ttdef"><b>Definition:</b> icalparameter.c:386</div></div> +<div class="line"><a class="code" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div> +<div class="ttc" id="aicalparameter_8h_html_adf6329d175597783232853ff1ca53e24"><div class="ttname"><a href="icalparameter_8h.html#adf6329d175597783232853ff1ca53e24">icalparameter_set_iana_value</a></div><div class="ttdeci">void icalparameter_set_iana_value(icalparameter *param, const char *v)</div><div class="ttdoc">Sets the IANA value of param to v.</div><div class="ttdef"><b>Definition:</b> icalparameter.c:390</div></div> +<div class="ttc" id="aicalparameter_8h_html_af315ea93079ce834a1cfd68a67294aab"><div class="ttname"><a href="icalparameter_8h.html#af315ea93079ce834a1cfd68a67294aab">icalparameter_get_iana_value</a></div><div class="ttdeci">const char * icalparameter_get_iana_value(icalparameter *param)</div><div class="ttdoc">Returns the IANA value of param.</div><div class="ttdef"><b>Definition:</b> icalparameter.c:395</div></div> </div><!-- fragment --> </dd></dl> </div> </div> -<a id="a28c4415b82455f7551aa4c48b36be438" name="a28c4415b82455f7551aa4c48b36be438"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a28c4415b82455f7551aa4c48b36be438">◆ </a></span>icalparameter_get_xname()</h2> +<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 class="memname">const char* icalparameter_get_xname </td> <td>(</td> <td class="paramtype">icalparameter * </td> <td class="paramname"><em>param</em></td><td>)</td> @@ -422,29 +375,29 @@ Functions</h2></td></tr> <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> <dl class="section user"><dt>Usage</dt><dd><div class="fragment"><div class="line"><span class="comment">// creates new parameter</span></div> -<div class="line">icalparameter *param = <a class="code hl_function" href="icalparameter_8h.html#a252cdad9d54b31b898ff273ce5439429">icalparameter_new</a>();</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 hl_function" href="icalparameter_8h.html#a2e77cb0c365e67a65487f916ece223da">icalparameter_set_xname</a>(param, <span class="stringliteral">"X-TEST"</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 hl_function" href="icalparameter_8h.html#a28c4415b82455f7551aa4c48b36be438">icalparameter_get_xname</a>(param), <span class="stringliteral">"X-TEST"</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 hl_function" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div> -<div class="ttc" id="aicalparameter_8h_html_a28c4415b82455f7551aa4c48b36be438"><div class="ttname"><a href="icalparameter_8h.html#a28c4415b82455f7551aa4c48b36be438">icalparameter_get_xname</a></div><div class="ttdeci">const char * icalparameter_get_xname(icalparameter *param)</div><div class="ttdoc">Returns the X-name of param.</div><div class="ttdef"><b>Definition:</b> icalparameter.c:356</div></div> -<div class="ttc" id="aicalparameter_8h_html_a2e77cb0c365e67a65487f916ece223da"><div class="ttname"><a href="icalparameter_8h.html#a2e77cb0c365e67a65487f916ece223da">icalparameter_set_xname</a></div><div class="ttdeci">void icalparameter_set_xname(icalparameter *param, const char *v)</div><div class="ttdoc">Sets the X-name of param to v.</div><div class="ttdef"><b>Definition:</b> icalparameter.c:340</div></div> +<div class="line"><a class="code" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div> +<div class="ttc" id="aicalparameter_8h_html_a0e5cea8520c67d68a9f129838a9a6e83"><div class="ttname"><a href="icalparameter_8h.html#a0e5cea8520c67d68a9f129838a9a6e83">icalparameter_get_xname</a></div><div class="ttdeci">const char * icalparameter_get_xname(icalparameter *param)</div><div class="ttdoc">Returns the X-name of param.</div><div class="ttdef"><b>Definition:</b> icalparameter.c:360</div></div> +<div class="ttc" id="aicalparameter_8h_html_a2e77cb0c365e67a65487f916ece223da"><div class="ttname"><a href="icalparameter_8h.html#a2e77cb0c365e67a65487f916ece223da">icalparameter_set_xname</a></div><div class="ttdeci">void icalparameter_set_xname(icalparameter *param, const char *v)</div><div class="ttdoc">Sets the X-name of param to v.</div><div class="ttdef"><b>Definition:</b> icalparameter.c:344</div></div> </div><!-- fragment --> </dd></dl> </div> </div> -<a id="a1e2ee9baea3213f18d2b93cdf3892c72" name="a1e2ee9baea3213f18d2b93cdf3892c72"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a1e2ee9baea3213f18d2b93cdf3892c72">◆ </a></span>icalparameter_get_xvalue()</h2> +<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 class="memname">const char* icalparameter_get_xvalue </td> <td>(</td> <td class="paramtype">icalparameter * </td> <td class="paramname"><em>param</em></td><td>)</td> @@ -465,23 +418,23 @@ Functions</h2></td></tr> <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> <dl class="section user"><dt>Usage</dt><dd><div class="fragment"><div class="line"><span class="comment">// create new parameter</span></div> -<div class="line">icalparameter *param = <a class="code hl_function" href="icalparameter_8h.html#aa3f2cce04d344d002ca83e797c05dd8b">icalparameter_new_from_string</a>(<span class="stringliteral">"X-TEST=FAIL"</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 hl_function" href="icalparameter_8h.html#aaf0fbf906d011f5af3ce38b626906691">icalparameter_set_xvalue</a>(param, <span class="stringliteral">"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 hl_function" href="icalparameter_8h.html#a1e2ee9baea3213f18d2b93cdf3892c72">icalparameter_get_xvalue</a>(param), <span class="stringliteral">"SUCCESS"</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 hl_function" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div> -<div class="ttc" id="aicalparameter_8h_html_a1e2ee9baea3213f18d2b93cdf3892c72"><div class="ttname"><a href="icalparameter_8h.html#a1e2ee9baea3213f18d2b93cdf3892c72">icalparameter_get_xvalue</a></div><div class="ttdeci">const char * icalparameter_get_xvalue(icalparameter *param)</div><div class="ttdoc">Returns the X-value of param.</div><div class="ttdef"><b>Definition:</b> icalparameter.c:379</div></div> -<div class="ttc" id="aicalparameter_8h_html_aaf0fbf906d011f5af3ce38b626906691"><div class="ttname"><a href="icalparameter_8h.html#aaf0fbf906d011f5af3ce38b626906691">icalparameter_set_xvalue</a></div><div class="ttdeci">void icalparameter_set_xvalue(icalparameter *param, const char *v)</div><div class="ttdoc">Sets the X-value of param to v.</div><div class="ttdef"><b>Definition:</b> icalparameter.c:363</div></div> +<div class="line"><a class="code" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div> +<div class="ttc" id="aicalparameter_8h_html_a97de698d7db2cab7c894c67b3d8fb673"><div class="ttname"><a href="icalparameter_8h.html#a97de698d7db2cab7c894c67b3d8fb673">icalparameter_get_xvalue</a></div><div class="ttdeci">const char * icalparameter_get_xvalue(icalparameter *param)</div><div class="ttdoc">Returns the X-value of param.</div><div class="ttdef"><b>Definition:</b> icalparameter.c:383</div></div> +<div class="ttc" id="aicalparameter_8h_html_aaf0fbf906d011f5af3ce38b626906691"><div class="ttname"><a href="icalparameter_8h.html#aaf0fbf906d011f5af3ce38b626906691">icalparameter_set_xvalue</a></div><div class="ttdeci">void icalparameter_set_xvalue(icalparameter *param, const char *v)</div><div class="ttdoc">Sets the X-value of param to v.</div><div class="ttdef"><b>Definition:</b> icalparameter.c:367</div></div> </div><!-- fragment --> </dd></dl> </div> </div> -<a id="add735467f8a84b476f5899e262a072a2" name="add735467f8a84b476f5899e262a072a2"></a> +<a id="add735467f8a84b476f5899e262a072a2"></a> <h2 class="memtitle"><span class="permalink"><a href="#add735467f8a84b476f5899e262a072a2">◆ </a></span>icalparameter_has_same_name()</h2> <div class="memitem"> @@ -519,21 +472,21 @@ Functions</h2></td></tr> <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> <dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"><span class="comment">// create two parameters</span></div> -<div class="line">icalparameter *param1 = <a class="code hl_function" href="icalparameter_8h.html#aa3f2cce04d344d002ca83e797c05dd8b">icalparameter_new_from_string</a>(<span class="stringliteral">"ROLE=CHAIR"</span>);</div> -<div class="line">icalparameter *param2 = <a class="code hl_function" href="icalparameter_8h.html#aa3f2cce04d344d002ca83e797c05dd8b">icalparameter_new_from_string</a>(<span class="stringliteral">"EMAIL=mailto@example.com"</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 hl_function" href="icalparameter_8h.html#add735467f8a84b476f5899e262a072a2">icalparameter_has_same_name</a>(param1, param2) == 0);</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 hl_function" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param1);</div> -<div class="line"><a class="code hl_function" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param2);</div> -<div class="ttc" id="aicalparameter_8h_html_add735467f8a84b476f5899e262a072a2"><div class="ttname"><a href="icalparameter_8h.html#add735467f8a84b476f5899e262a072a2">icalparameter_has_same_name</a></div><div class="ttdeci">int icalparameter_has_same_name(icalparameter *param1, icalparameter *param2)</div><div class="ttdoc">Determines if two parameters have the same name.</div><div class="ttdef"><b>Definition:</b> icalparameter.c:420</div></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 class="ttc" id="aicalparameter_8h_html_add735467f8a84b476f5899e262a072a2"><div class="ttname"><a href="icalparameter_8h.html#add735467f8a84b476f5899e262a072a2">icalparameter_has_same_name</a></div><div class="ttdeci">int icalparameter_has_same_name(icalparameter *param1, icalparameter *param2)</div><div class="ttdoc">Determines if two parameters have the same name.</div><div class="ttdef"><b>Definition:</b> icalparameter.c:424</div></div> </div><!-- fragment --> </dd></dl> </div> </div> -<a id="a0671e8fcd545049a3fbc1b5d5d0f2b2b" name="a0671e8fcd545049a3fbc1b5d5d0f2b2b"></a> +<a id="a0671e8fcd545049a3fbc1b5d5d0f2b2b"></a> <h2 class="memtitle"><span class="permalink"><a href="#a0671e8fcd545049a3fbc1b5d5d0f2b2b">◆ </a></span>icalparameter_isa()</h2> <div class="memitem"> @@ -548,7 +501,7 @@ Functions</h2></td></tr> </tr> </table> </div><div class="memdoc"> -<p >Returns the icalparameter_kind of parameter.</p> +<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> @@ -557,19 +510,19 @@ Functions</h2></td></tr> </dl> <dl class="section return"><dt>Returns</dt><dd>The icalparameter_kind of the parameter</dd></dl> <p><b>Error</b> handling Returns ICAL_NO_PARAMETER when passed NULL.</p> -<p ><b>Usage</b> </p><div class="fragment"><div class="line"><span class="comment">// create parameter</span></div> -<div class="line">icalparameter *param = <a class="code hl_function" href="icalparameter_8h.html#aa3f2cce04d344d002ca83e797c05dd8b">icalparameter_new_from_string</a>(<span class="stringliteral">"ROLE=CHAIR"</span>);</div> +<p><b>Usage</b> </p><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 hl_function" href="icalparameter_8h.html#a0671e8fcd545049a3fbc1b5d5d0f2b2b">icalparameter_isa</a>(param) == ICAL_ROLE_PARAMETER);</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 hl_function" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div> -<div class="ttc" id="aicalparameter_8h_html_a0671e8fcd545049a3fbc1b5d5d0f2b2b"><div class="ttname"><a href="icalparameter_8h.html#a0671e8fcd545049a3fbc1b5d5d0f2b2b">icalparameter_isa</a></div><div class="ttdeci">icalparameter_kind icalparameter_isa(icalparameter *parameter)</div><div class="ttdef"><b>Definition:</b> icalparameter.c:316</div></div> +<div class="line"><a class="code" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div> +<div class="ttc" id="aicalparameter_8h_html_a0671e8fcd545049a3fbc1b5d5d0f2b2b"><div class="ttname"><a href="icalparameter_8h.html#a0671e8fcd545049a3fbc1b5d5d0f2b2b">icalparameter_isa</a></div><div class="ttdeci">icalparameter_kind icalparameter_isa(icalparameter *parameter)</div><div class="ttdef"><b>Definition:</b> icalparameter.c:320</div></div> </div><!-- fragment --> </div> </div> -<a id="a960908ba27797c51f965b997be99f284" name="a960908ba27797c51f965b997be99f284"></a> +<a id="a960908ba27797c51f965b997be99f284"></a> <h2 class="memtitle"><span class="permalink"><a href="#a960908ba27797c51f965b997be99f284">◆ </a></span>icalparameter_isa_parameter()</h2> <div class="memitem"> @@ -584,7 +537,7 @@ Functions</h2></td></tr> </tr> </table> </div><div class="memdoc"> -<p >Determines if the given param is an icalparameter </p><dl class="params"><dt>Parameters</dt><dd> +<p>Determines 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> @@ -593,19 +546,19 @@ Functions</h2></td></tr> <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, its behavior is undefined.</dd></dl> <p><b>Error</b> handling When given a <code>NULL</code> object, it returns 0.</p> -<p ><b>Usage</b> </p><div class="fragment"><div class="line"><span class="comment">// create parameter</span></div> -<div class="line">icalparameter *param = <a class="code hl_function" href="icalparameter_8h.html#aa3f2cce04d344d002ca83e797c05dd8b">icalparameter_new_from_string</a>(<span class="stringliteral">"ROLE=CHAIR"</span>);</div> +<p><b>Usage</b> </p><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 hl_function" href="icalparameter_8h.html#a960908ba27797c51f965b997be99f284">icalparameter_isa_parameter</a>(param));</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 hl_function" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div> -<div class="ttc" id="aicalparameter_8h_html_a960908ba27797c51f965b997be99f284"><div class="ttname"><a href="icalparameter_8h.html#a960908ba27797c51f965b997be99f284">icalparameter_isa_parameter</a></div><div class="ttdeci">int icalparameter_isa_parameter(void *param)</div><div class="ttdef"><b>Definition:</b> icalparameter.c:325</div></div> +<div class="line"><a class="code" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div> +<div class="ttc" id="aicalparameter_8h_html_a960908ba27797c51f965b997be99f284"><div class="ttname"><a href="icalparameter_8h.html#a960908ba27797c51f965b997be99f284">icalparameter_isa_parameter</a></div><div class="ttdeci">int icalparameter_isa_parameter(void *param)</div><div class="ttdef"><b>Definition:</b> icalparameter.c:329</div></div> </div><!-- fragment --> </div> </div> -<a id="a236331311b5c8957e718f6abb205fb66" name="a236331311b5c8957e718f6abb205fb66"></a> +<a id="a236331311b5c8957e718f6abb205fb66"></a> <h2 class="memtitle"><span class="permalink"><a href="#a236331311b5c8957e718f6abb205fb66">◆ </a></span>icalparameter_kind_is_valid()</h2> <div class="memitem"> @@ -629,21 +582,21 @@ Functions</h2></td></tr> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>1 if <em>kind</em> is valid, 0 otherwise</dd></dl> -<dl class="section user"><dt>Usage</dt><dd><div class="fragment"><div class="line">assert(<a class="code hl_function" href="icalparameter_8h.html#a236331311b5c8957e718f6abb205fb66">icalparameter_kind_is_valid</a>(ICAL_ROLE_PARAMETER));</div> +<dl class="section user"><dt>Usage</dt><dd><div class="fragment"><div class="line">assert(<a class="code" href="icalparameter_8h.html#a236331311b5c8957e718f6abb205fb66">icalparameter_kind_is_valid</a>(ICAL_ROLE_PARAMETER));</div> <div class="ttc" id="aicalparameter_8h_html_a236331311b5c8957e718f6abb205fb66"><div class="ttname"><a href="icalparameter_8h.html#a236331311b5c8957e718f6abb205fb66">icalparameter_kind_is_valid</a></div><div class="ttdeci">int icalparameter_kind_is_valid(const icalparameter_kind kind)</div><div class="ttdoc">Checks the validity of a icalparameter_kind.</div></div> </div><!-- fragment --> </dd></dl> <dl class="section since"><dt>Since</dt><dd>3.0.4 </dd></dl> </div> </div> -<a id="a6a172a9cc1bc5cc1315f96e6cad70438" name="a6a172a9cc1bc5cc1315f96e6cad70438"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a6a172a9cc1bc5cc1315f96e6cad70438">◆ </a></span>icalparameter_kind_to_string()</h2> +<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 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> @@ -662,22 +615,22 @@ Functions</h2></td></tr> <dl class="section return"><dt>Returns</dt><dd>A string representing <em>kind</em> </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> -<dl class="section user"><dt>Usage</dt><dd><div class="fragment"><div class="line">assert(0 == strcmp(<a class="code hl_function" href="icalparameter_8h.html#a6a172a9cc1bc5cc1315f96e6cad70438">icalparameter_kind_to_string</a>(ICAL_ROLE_PARAMETER), <span class="stringliteral">"ROLE"</span>));</div> -<div class="line">assert(0 == strcmp(<a class="code hl_function" href="icalparameter_8h.html#a6a172a9cc1bc5cc1315f96e6cad70438">icalparameter_kind_to_string</a>(ICAL_EMAIL_PARAMETER), <span class="stringliteral">"EMAIL));</span></div> +<dl class="section user"><dt>Usage</dt><dd><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 class="ttc" id="aicalparameter_8h_html_a6a172a9cc1bc5cc1315f96e6cad70438"><div class="ttname"><a href="icalparameter_8h.html#a6a172a9cc1bc5cc1315f96e6cad70438">icalparameter_kind_to_string</a></div><div class="ttdeci">const char * icalparameter_kind_to_string(icalparameter_kind kind)</div><div class="ttdoc">Returns a string representing the given icalparameter_kind.</div></div> +<div class="ttc" id="aicalparameter_8h_html_af2bc3ace454dda792d4847dcc919d241"><div class="ttname"><a href="icalparameter_8h.html#af2bc3ace454dda792d4847dcc919d241">icalparameter_kind_to_string</a></div><div class="ttdeci">const char * icalparameter_kind_to_string(icalparameter_kind kind)</div><div class="ttdoc">Returns a string representing the given icalparameter_kind.</div></div> </div><!-- fragment --> </dd></dl> </div> </div> -<a id="a252cdad9d54b31b898ff273ce5439429" name="a252cdad9d54b31b898ff273ce5439429"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a252cdad9d54b31b898ff273ce5439429">◆ </a></span>icalparameter_new()</h2> +<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 class="memname">icalparameter* icalparameter_new </td> <td>(</td> <td class="paramtype">icalparameter_kind </td> <td class="paramname"><em>kind</em></td><td>)</td> @@ -697,26 +650,26 @@ Functions</h2></td></tr> <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> <dl class="section user"><dt>Usage</dt><dd><div class="fragment"><div class="line"><span class="comment">// create new parameter</span></div> -<div class="line">icalparameter *parameter = <a class="code hl_function" href="icalparameter_8h.html#a252cdad9d54b31b898ff273ce5439429">icalparameter_new</a>();</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 hl_function" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(parameter);</div> +<div class="line"><a class="code" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(parameter);</div> </div><!-- fragment --> </dd></dl> </div> </div> -<a id="a913f1e9184b211c0c59a7b36e2710264" name="a913f1e9184b211c0c59a7b36e2710264"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a913f1e9184b211c0c59a7b36e2710264">◆ </a></span>icalparameter_new_clone()</h2> +<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 class="memname">icalparameter* icalparameter_new_clone </td> <td>(</td> <td class="paramtype">icalparameter * </td> <td class="paramname"><em>p</em></td><td>)</td> @@ -739,7 +692,7 @@ Functions</h2></td></tr> <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_clone(param);</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> @@ -749,19 +702,17 @@ Functions</h2></td></tr> <div class="line">icalparameter_free(param);</div> <div class="line">icalparameter_free(clone);</div> </div><!-- fragment --> </dd></dl> -<dl class="section since"><dt>Since</dt><dd>3.1.0 </dd></dl> -<dl class="deprecated"><dt><b><a class="el" href="deprecated.html#_deprecated000004">Deprecated:</a></b></dt><dd>Use <a class="el" href="icalparameter_8h.html#a736a5b4f88c51ba730fddb29981c57de" title="Creates new icalparameter as a clone of the given one.">icalparameter_clone()</a> instead </dd></dl> </div> </div> -<a id="aa3f2cce04d344d002ca83e797c05dd8b" name="aa3f2cce04d344d002ca83e797c05dd8b"></a> -<h2 class="memtitle"><span class="permalink"><a href="#aa3f2cce04d344d002ca83e797c05dd8b">◆ </a></span>icalparameter_new_from_string()</h2> +<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 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> @@ -780,25 +731,25 @@ Functions</h2></td></tr> <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> -<dl class="section user"><dt>Usage</dt><dd><div class="fragment"><div class="line">icalparameter *param = <a class="code hl_function" href="icalparameter_8h.html#aa3f2cce04d344d002ca83e797c05dd8b">icalparameter_new_from_string</a>(<span class="stringliteral">"ROLE=CHAIR"</span>);</div> +<dl class="section user"><dt>Usage</dt><dd><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 hl_function" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div> +<div class="line"><a class="code" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div> </div><!-- fragment --> </dd></dl> </div> </div> -<a id="abe33daa839d72261aab283d0f44f711f" name="abe33daa839d72261aab283d0f44f711f"></a> -<h2 class="memtitle"><span class="permalink"><a href="#abe33daa839d72261aab283d0f44f711f">◆ </a></span>icalparameter_new_from_value_string()</h2> +<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 class="memname">icalparameter* icalparameter_new_from_value_string </td> <td>(</td> <td class="paramtype">icalparameter_kind </td> <td class="paramname"><em>kind</em>, </td> @@ -830,20 +781,20 @@ Functions</h2></td></tr> <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> <dl class="section user"><dt>Example</dt><dd><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 hl_function" href="icalparameter_8h.html#abe33daa839d72261aab283d0f44f711f">icalparameter_new_from_value_string</a>(ICAL_ROLE_PARAMETER, <span class="stringliteral">"CHAIR"</span>);</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 hl_function" href="icalparameter_8h.html#ab644f9bab546eea75306f349914af05a">icalparameter_get_iana_name</a>(param), <span class="stringliteral">"ROLE"</span>));</div> -<div class="line">assert(0 == strcmp(<a class="code hl_function" href="icalparameter_8h.html#a93de301878e702d08cf89dae83c071f7">icalparameter_get_iana_value</a>(param), <span class="stringliteral">"CHAIR"</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 hl_function" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div> -<div class="ttc" id="aicalparameter_8h_html_abe33daa839d72261aab283d0f44f711f"><div class="ttname"><a href="icalparameter_8h.html#abe33daa839d72261aab283d0f44f711f">icalparameter_new_from_value_string</a></div><div class="ttdeci">icalparameter * icalparameter_new_from_value_string(icalparameter_kind kind, const char *value)</div><div class="ttdoc">Creates new icalparameter of a given kind with a given value.</div></div> +<div class="line"><a class="code" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div> +<div class="ttc" id="aicalparameter_8h_html_a6f785010533a0f63de5ef811d7ea0e87"><div class="ttname"><a href="icalparameter_8h.html#a6f785010533a0f63de5ef811d7ea0e87">icalparameter_new_from_value_string</a></div><div class="ttdeci">icalparameter * icalparameter_new_from_value_string(icalparameter_kind kind, const char *value)</div><div class="ttdoc">Creates new icalparameter of a given kind with a given value.</div></div> </div><!-- fragment --> </dd></dl> </div> </div> -<a id="aab70ecf438e02384a5a13ca6a71e7793" name="aab70ecf438e02384a5a13ca6a71e7793"></a> +<a id="aab70ecf438e02384a5a13ca6a71e7793"></a> <h2 class="memtitle"><span class="permalink"><a href="#aab70ecf438e02384a5a13ca6a71e7793">◆ </a></span>icalparameter_set_iana_name()</h2> <div class="memitem"> @@ -877,24 +828,24 @@ Functions</h2></td></tr> </table> </dd> </dl> -<dl class="section see"><dt>See also</dt><dd><a class="el" href="icalparameter_8h.html#ab644f9bab546eea75306f349914af05a" title="Returns the IANA name of param.">icalparameter_get_iana_name()</a></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 :calerrno 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> <dl class="section user"><dt>Usage</dt><dd><div class="fragment"><div class="line"><span class="comment">// creates new parameter</span></div> -<div class="line">icalparameter *param = <a class="code hl_function" href="icalparameter_8h.html#a252cdad9d54b31b898ff273ce5439429">icalparameter_new</a>();</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 hl_function" href="icalparameter_8h.html#aab70ecf438e02384a5a13ca6a71e7793">icalparameter_set_iana_name</a>(param, <span class="stringliteral">"ROLE"</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 hl_function" href="icalparameter_8h.html#ab644f9bab546eea75306f349914af05a">icalparameter_get_iana_name</a>(param), <span class="stringliteral">"X-TEST"</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 hl_function" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div> +<div class="line"><a class="code" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div> </div><!-- fragment --> </dd></dl> </div> </div> -<a id="adf6329d175597783232853ff1ca53e24" name="adf6329d175597783232853ff1ca53e24"></a> +<a id="adf6329d175597783232853ff1ca53e24"></a> <h2 class="memtitle"><span class="permalink"><a href="#adf6329d175597783232853ff1ca53e24">◆ </a></span>icalparameter_set_iana_value()</h2> <div class="memitem"> @@ -928,25 +879,25 @@ Functions</h2></td></tr> </table> </dd> </dl> -<dl class="section see"><dt>See also</dt><dd><a class="el" href="icalparameter_8h.html#a93de301878e702d08cf89dae83c071f7" title="Returns the IANA value of param.">icalparameter_get_iana_value()</a></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> <dl class="section user"><dt>Usage</dt><dd><div class="fragment"><div class="line"><span class="comment">// create new parameter</span></div> -<div class="line">icalparameter *param = <a class="code hl_function" href="icalparameter_8h.html#aa3f2cce04d344d002ca83e797c05dd8b">icalparameter_new_from_string</a>(<span class="stringliteral">"ROLE=ATTENDEE"</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 hl_function" href="icalparameter_8h.html#adf6329d175597783232853ff1ca53e24">icalparameter_set_iana_value</a>(param, <span class="stringliteral">"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 hl_function" href="icalparameter_8h.html#a93de301878e702d08cf89dae83c071f7">icalparameter_get_iana_value</a>(param), <span class="stringliteral">"SUCCESS"</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 hl_function" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div> +<div class="line"><a class="code" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div> </div><!-- fragment --> </dd></dl> </div> </div> -<a id="a2e77cb0c365e67a65487f916ece223da" name="a2e77cb0c365e67a65487f916ece223da"></a> +<a id="a2e77cb0c365e67a65487f916ece223da"></a> <h2 class="memtitle"><span class="permalink"><a href="#a2e77cb0c365e67a65487f916ece223da">◆ </a></span>icalparameter_set_xname()</h2> <div class="memitem"> @@ -980,24 +931,24 @@ Functions</h2></td></tr> </table> </dd> </dl> -<dl class="section see"><dt>See also</dt><dd><a class="el" href="icalparameter_8h.html#a28c4415b82455f7551aa4c48b36be438" title="Returns the X-name of param.">icalparameter_get_xname()</a></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> <dl class="section user"><dt>Usage</dt><dd><div class="fragment"><div class="line"><span class="comment">// creates new parameter</span></div> -<div class="line">icalparameter *param = <a class="code hl_function" href="icalparameter_8h.html#a252cdad9d54b31b898ff273ce5439429">icalparameter_new</a>();</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 hl_function" href="icalparameter_8h.html#a2e77cb0c365e67a65487f916ece223da">icalparameter_set_xname</a>(param, <span class="stringliteral">"X-TEST"</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 hl_function" href="icalparameter_8h.html#a28c4415b82455f7551aa4c48b36be438">icalparameter_get_xname</a>(param), <span class="stringliteral">"X-TEST"</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 hl_function" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div> +<div class="line"><a class="code" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div> </div><!-- fragment --> </dd></dl> </div> </div> -<a id="aaf0fbf906d011f5af3ce38b626906691" name="aaf0fbf906d011f5af3ce38b626906691"></a> +<a id="aaf0fbf906d011f5af3ce38b626906691"></a> <h2 class="memtitle"><span class="permalink"><a href="#aaf0fbf906d011f5af3ce38b626906691">◆ </a></span>icalparameter_set_xvalue()</h2> <div class="memitem"> @@ -1031,25 +982,25 @@ Functions</h2></td></tr> </table> </dd> </dl> -<dl class="section see"><dt>See also</dt><dd><a class="el" href="icalparameter_8h.html#a1e2ee9baea3213f18d2b93cdf3892c72" title="Returns the X-value of param.">icalparameter_get_xvalue()</a></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> <dl class="section user"><dt>Usage</dt><dd><div class="fragment"><div class="line"><span class="comment">// create new parameter</span></div> -<div class="line">icalparameter *param = <a class="code hl_function" href="icalparameter_8h.html#aa3f2cce04d344d002ca83e797c05dd8b">icalparameter_new_from_string</a>(<span class="stringliteral">"X-TEST=FAIL"</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 hl_function" href="icalparameter_8h.html#aaf0fbf906d011f5af3ce38b626906691">icalparameter_set_xvalue</a>(param, <span class="stringliteral">"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 hl_function" href="icalparameter_8h.html#a1e2ee9baea3213f18d2b93cdf3892c72">icalparameter_get_xvalue</a>(param), <span class="stringliteral">"SUCCESS"</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 hl_function" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div> +<div class="line"><a class="code" href="icalparameter_8h.html#aafadb9fd4172bab0d17252d251c69800">icalparameter_free</a>(param);</div> </div><!-- fragment --> </dd></dl> </div> </div> -<a id="a4e659bfa64d0c6c7cc3da29aadc5d3d6" name="a4e659bfa64d0c6c7cc3da29aadc5d3d6"></a> +<a id="a4e659bfa64d0c6c7cc3da29aadc5d3d6"></a> <h2 class="memtitle"><span class="permalink"><a href="#a4e659bfa64d0c6c7cc3da29aadc5d3d6">◆ </a></span>icalparameter_string_to_kind()</h2> <div class="memitem"> @@ -1075,9 +1026,9 @@ 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> -<dl class="section user"><dt>Usage</dt><dd><div class="fragment"><div class="line">assert(<a class="code hl_function" 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 hl_function" 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 hl_function" href="icalparameter_8h.html#a4e659bfa64d0c6c7cc3da29aadc5d3d6">icalparameter_string_to_kind</a>(<span class="stringliteral">"ID"</span>) == ICAL_ID_PARAMETER);</div> +<dl class="section user"><dt>Usage</dt><dd><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 class="ttc" id="aicalparameter_8h_html_a4e659bfa64d0c6c7cc3da29aadc5d3d6"><div class="ttname"><a href="icalparameter_8h.html#a4e659bfa64d0c6c7cc3da29aadc5d3d6">icalparameter_string_to_kind</a></div><div class="ttdeci">icalparameter_kind icalparameter_string_to_kind(const char *string)</div><div class="ttdoc">Returns the icalparameter_kind for a given string.</div></div> </div><!-- fragment --> </dd></dl> @@ -1086,7 +1037,7 @@ Functions</h2></td></tr> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> -Generated on Sat Jun 25 2022 08:55:43 for Libical API Documentation by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.3 +Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </small></address> </body> </html> |