diff options
Diffstat (limited to 'apidocs/icalperiod_8h.html')
| -rw-r--r-- | apidocs/icalperiod_8h.html | 127 |
1 files changed, 64 insertions, 63 deletions
diff --git a/apidocs/icalperiod_8h.html b/apidocs/icalperiod_8h.html index a93c3089..814b73e7 100644 --- a/apidocs/icalperiod_8h.html +++ b/apidocs/icalperiod_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: icalperiod.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" @@ -70,7 +70,8 @@ $(function() { <a href="#nested-classes">Data Structures</a> | <a href="#define-members">Macros</a> | <a href="#func-members">Functions</a> </div> - <div class="headertitle"><div class="title">icalperiod.h File Reference</div></div> + <div class="headertitle"> +<div class="title">icalperiod.h File Reference</div> </div> </div><!--header--> <div class="contents"> @@ -79,25 +80,25 @@ $(function() { <p><a href="icalperiod_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="nested-classes" name="nested-classes"></a> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> Data Structures</h2></td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structicalperiodtype.html">icalperiodtype</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Struct to represent a period in time. <a href="structicalperiodtype.html#details">More...</a><br /></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> Macros</h2></td></tr> -<tr class="memitem:ac369ae6f4dd1b5a6e0f9b2f4cf6e2e34"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="icalperiod_8h.html#ac369ae6f4dd1b5a6e0f9b2f4cf6e2e34">ICALPERIODTYPE_INITIALIZER</a></td></tr> +<tr class="memitem:ac369ae6f4dd1b5a6e0f9b2f4cf6e2e34"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><b>ICALPERIODTYPE_INITIALIZER</b></td></tr> <tr class="separator:ac369ae6f4dd1b5a6e0f9b2f4cf6e2e34"><td class="memSeparator" colspan="2"> </td></tr> </table><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:a28a5aa968b36182e39d7f3fd3491ecb3"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalperiod_8h.html#a28a5aa968b36182e39d7f3fd3491ecb3">icalperiodtype_as_ical_string</a> (struct <a class="el" href="structicalperiodtype.html">icalperiodtype</a> p)</td></tr> -<tr class="memdesc:a28a5aa968b36182e39d7f3fd3491ecb3"><td class="mdescLeft"> </td><td class="mdescRight">Converts an <a class="el" href="structicalperiodtype.html" title="Struct to represent a period in time.">icalperiodtype</a> into an iCal-formatted string. <a href="icalperiod_8h.html#a28a5aa968b36182e39d7f3fd3491ecb3">More...</a><br /></td></tr> -<tr class="separator:a28a5aa968b36182e39d7f3fd3491ecb3"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a2f7c3f3e1623c9774596d1ef68789171"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalperiod_8h.html#a2f7c3f3e1623c9774596d1ef68789171">icalperiodtype_as_ical_string_r</a> (struct <a class="el" href="structicalperiodtype.html">icalperiodtype</a> p)</td></tr> -<tr class="memdesc:a2f7c3f3e1623c9774596d1ef68789171"><td class="mdescLeft"> </td><td class="mdescRight">Converts an <a class="el" href="structicalperiodtype.html" title="Struct to represent a period in time.">icalperiodtype</a> into an iCal-formatted string. <a href="icalperiod_8h.html#a2f7c3f3e1623c9774596d1ef68789171">More...</a><br /></td></tr> -<tr class="separator:a2f7c3f3e1623c9774596d1ef68789171"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac84e7fc00fa25286c1f109eb35a10883"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalperiod_8h.html#ac84e7fc00fa25286c1f109eb35a10883">icalperiodtype_as_ical_string</a> (struct <a class="el" href="structicalperiodtype.html">icalperiodtype</a> p)</td></tr> +<tr class="memdesc:ac84e7fc00fa25286c1f109eb35a10883"><td class="mdescLeft"> </td><td class="mdescRight">Converts an <a class="el" href="structicalperiodtype.html" title="Struct to represent a period in time.">icalperiodtype</a> into an iCal-formatted string. <a href="icalperiod_8h.html#ac84e7fc00fa25286c1f109eb35a10883">More...</a><br /></td></tr> +<tr class="separator:ac84e7fc00fa25286c1f109eb35a10883"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ac71be7790d778145a59ad9626458ccd5"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalperiod_8h.html#ac71be7790d778145a59ad9626458ccd5">icalperiodtype_as_ical_string_r</a> (struct <a class="el" href="structicalperiodtype.html">icalperiodtype</a> p)</td></tr> +<tr class="memdesc:ac71be7790d778145a59ad9626458ccd5"><td class="mdescLeft"> </td><td class="mdescRight">Converts an <a class="el" href="structicalperiodtype.html" title="Struct to represent a period in time.">icalperiodtype</a> into an iCal-formatted string. <a href="icalperiod_8h.html#ac71be7790d778145a59ad9626458ccd5">More...</a><br /></td></tr> +<tr class="separator:ac71be7790d778145a59ad9626458ccd5"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a827e35abf4d6349e15aeaa9a483064fd"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structicalperiodtype.html">icalperiodtype</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="icalperiod_8h.html#a827e35abf4d6349e15aeaa9a483064fd">icalperiodtype_from_string</a> (const char *str)</td></tr> <tr class="memdesc:a827e35abf4d6349e15aeaa9a483064fd"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new <a class="el" href="structicalperiodtype.html" title="Struct to represent a period in time.">icalperiodtype</a> from <em>str</em>. <a href="icalperiod_8h.html#a827e35abf4d6349e15aeaa9a483064fd">More...</a><br /></td></tr> <tr class="separator:a827e35abf4d6349e15aeaa9a483064fd"><td class="memSeparator" colspan="2"> </td></tr> @@ -109,9 +110,9 @@ Functions</h2></td></tr> <tr class="separator:a60e59a9f46a1efa9885829a4d23eddfa"><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 for working with iCal periods (of time). </p> +<div class="textblock"><p>Functions for working with iCal periods (of time). </p> </div><h2 class="groupheader">Macro Definition Documentation</h2> -<a id="ac369ae6f4dd1b5a6e0f9b2f4cf6e2e34" name="ac369ae6f4dd1b5a6e0f9b2f4cf6e2e34"></a> +<a id="ac369ae6f4dd1b5a6e0f9b2f4cf6e2e34"></a> <h2 class="memtitle"><span class="permalink"><a href="#ac369ae6f4dd1b5a6e0f9b2f4cf6e2e34">◆ </a></span>ICALPERIODTYPE_INITIALIZER</h2> <div class="memitem"> @@ -131,14 +132,14 @@ Functions</h2></td></tr> </div> </div> <h2 class="groupheader">Function Documentation</h2> -<a id="a28a5aa968b36182e39d7f3fd3491ecb3" name="a28a5aa968b36182e39d7f3fd3491ecb3"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a28a5aa968b36182e39d7f3fd3491ecb3">◆ </a></span>icalperiodtype_as_ical_string()</h2> +<a id="ac84e7fc00fa25286c1f109eb35a10883"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ac84e7fc00fa25286c1f109eb35a10883">◆ </a></span>icalperiodtype_as_ical_string()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">const char * icalperiodtype_as_ical_string </td> + <td class="memname">const char* icalperiodtype_as_ical_string </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structicalperiodtype.html">icalperiodtype</a> </td> <td class="paramname"><em>p</em></td><td>)</td> @@ -155,30 +156,30 @@ Functions</h2></td></tr> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>A string representing the iCal-formatted period </dd></dl> -<dl class="section see"><dt>See also</dt><dd><a class="el" href="icalperiod_8h.html#a2f7c3f3e1623c9774596d1ef68789171" title="Converts an icalperiodtype into an iCal-formatted string.">icalperiodtype_as_ical_string_r()</a></dd></dl> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="icalperiod_8h.html#ac71be7790d778145a59ad9626458ccd5" title="Converts an icalperiodtype into an iCal-formatted string.">icalperiodtype_as_ical_string_r()</a></dd></dl> <dl class="section user"><dt>Error handling</dt><dd>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#a601c122fcea522513b1b7732fa23e833a3ed4d866c28acaaaf99348b1ab27cd78">ICAL_ALLOCATION_ERROR</a> if there was an internal error allocating memory.</dd></dl> <dl class="section user"><dt>Ownership</dt><dd>The string returned by this method is owned by libical and must not be <code>free()</code> by the caller.</dd></dl> <dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"><span class="comment">// create icalperiodtype</span></div> <div class="line"><span class="keyword">const</span> <span class="keywordtype">char</span> *period_string = <span class="stringliteral">"20170606T090000/20170607T090000"</span>;</div> -<div class="line"><span class="keyword">struct </span><a class="code hl_struct" href="structicalperiodtype.html">icalperiodtype</a> period = <a class="code hl_function" href="icalperiod_8h.html#a827e35abf4d6349e15aeaa9a483064fd">icalperiodtype_from_string</a>(period_string);</div> +<div class="line"><span class="keyword">struct </span><a class="code" href="structicalperiodtype.html">icalperiodtype</a> period = <a class="code" href="icalperiod_8h.html#a827e35abf4d6349e15aeaa9a483064fd">icalperiodtype_from_string</a>(period_string);</div> <div class="line"> </div> <div class="line"><span class="comment">// print period in iCal format</span></div> -<div class="line">printf(<span class="stringliteral">"%s\n"</span>, <a class="code hl_function" href="icalperiod_8h.html#a28a5aa968b36182e39d7f3fd3491ecb3">icalperiodtype_as_ical_string</a>(period));</div> -<div class="ttc" id="aicalperiod_8h_html_a28a5aa968b36182e39d7f3fd3491ecb3"><div class="ttname"><a href="icalperiod_8h.html#a28a5aa968b36182e39d7f3fd3491ecb3">icalperiodtype_as_ical_string</a></div><div class="ttdeci">const char * icalperiodtype_as_ical_string(struct icalperiodtype p)</div><div class="ttdoc">Converts an icalperiodtype into an iCal-formatted string.</div><div class="ttdef"><b>Definition:</b> icalperiod.c:85</div></div> -<div class="ttc" id="aicalperiod_8h_html_a827e35abf4d6349e15aeaa9a483064fd"><div class="ttname"><a href="icalperiod_8h.html#a827e35abf4d6349e15aeaa9a483064fd">icalperiodtype_from_string</a></div><div class="ttdeci">struct icalperiodtype icalperiodtype_from_string(const char *str)</div><div class="ttdoc">Constructs a new icalperiodtype from str.</div><div class="ttdef"><b>Definition:</b> icalperiod.c:21</div></div> -<div class="ttc" id="astructicalperiodtype_html"><div class="ttname"><a href="structicalperiodtype.html">icalperiodtype</a></div><div class="ttdoc">Struct to represent a period in time.</div><div class="ttdef"><b>Definition:</b> icalperiod.h:29</div></div> +<div class="line">printf(<span class="stringliteral">"%s\n"</span>, <a class="code" href="icalperiod_8h.html#ac84e7fc00fa25286c1f109eb35a10883">icalperiodtype_as_ical_string</a>(period));</div> +<div class="ttc" id="aicalperiod_8h_html_a827e35abf4d6349e15aeaa9a483064fd"><div class="ttname"><a href="icalperiod_8h.html#a827e35abf4d6349e15aeaa9a483064fd">icalperiodtype_from_string</a></div><div class="ttdeci">struct icalperiodtype icalperiodtype_from_string(const char *str)</div><div class="ttdoc">Constructs a new icalperiodtype from str.</div><div class="ttdef"><b>Definition:</b> icalperiod.c:30</div></div> +<div class="ttc" id="aicalperiod_8h_html_ac84e7fc00fa25286c1f109eb35a10883"><div class="ttname"><a href="icalperiod_8h.html#ac84e7fc00fa25286c1f109eb35a10883">icalperiodtype_as_ical_string</a></div><div class="ttdeci">const char * icalperiodtype_as_ical_string(struct icalperiodtype p)</div><div class="ttdoc">Converts an icalperiodtype into an iCal-formatted string.</div><div class="ttdef"><b>Definition:</b> icalperiod.c:94</div></div> +<div class="ttc" id="astructicalperiodtype_html"><div class="ttname"><a href="structicalperiodtype.html">icalperiodtype</a></div><div class="ttdoc">Struct to represent a period in time.</div><div class="ttdef"><b>Definition:</b> icalperiod.h:38</div></div> </div><!-- fragment --> </dd></dl> </div> </div> -<a id="a2f7c3f3e1623c9774596d1ef68789171" name="a2f7c3f3e1623c9774596d1ef68789171"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a2f7c3f3e1623c9774596d1ef68789171">◆ </a></span>icalperiodtype_as_ical_string_r()</h2> +<a id="ac71be7790d778145a59ad9626458ccd5"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ac71be7790d778145a59ad9626458ccd5">◆ </a></span>icalperiodtype_as_ical_string_r()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">char * icalperiodtype_as_ical_string_r </td> + <td class="memname">char* icalperiodtype_as_ical_string_r </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structicalperiodtype.html">icalperiodtype</a> </td> <td class="paramname"><em>p</em></td><td>)</td> @@ -195,24 +196,24 @@ Functions</h2></td></tr> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>A string representing the iCal-formatted period </dd></dl> -<dl class="section see"><dt>See also</dt><dd><a class="el" href="icalperiod_8h.html#a28a5aa968b36182e39d7f3fd3491ecb3" title="Converts an icalperiodtype into an iCal-formatted string.">icalperiodtype_as_ical_string()</a></dd></dl> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="icalperiod_8h.html#ac84e7fc00fa25286c1f109eb35a10883" title="Converts an icalperiodtype into an iCal-formatted string.">icalperiodtype_as_ical_string()</a></dd></dl> <dl class="section user"><dt>Error handling</dt><dd>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#a601c122fcea522513b1b7732fa23e833a3ed4d866c28acaaaf99348b1ab27cd78">ICAL_ALLOCATION_ERROR</a> if there was an internal error allocating memory.</dd></dl> <dl class="section user"><dt>Ownership</dt><dd>The string returned by this method is owned by the caller and must be released with the appropriate function after use.</dd></dl> <dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"><span class="comment">// create icalperiodtype</span></div> <div class="line"><span class="keyword">const</span> <span class="keywordtype">char</span> *period_string = <span class="stringliteral">"20170606T090000/20170607T090000"</span>;</div> -<div class="line"><span class="keyword">struct </span><a class="code hl_struct" href="structicalperiodtype.html">icalperiodtype</a> period = <a class="code hl_function" href="icalperiod_8h.html#a827e35abf4d6349e15aeaa9a483064fd">icalperiodtype_from_string</a>(period_string);</div> +<div class="line"><span class="keyword">struct </span><a class="code" href="structicalperiodtype.html">icalperiodtype</a> period = <a class="code" href="icalperiod_8h.html#a827e35abf4d6349e15aeaa9a483064fd">icalperiodtype_from_string</a>(period_string);</div> <div class="line"> </div> <div class="line"><span class="comment">// print period in iCal format</span></div> -<div class="line"><span class="keyword">const</span> <span class="keywordtype">char</span> *period_string_gen = <a class="code hl_function" href="icalperiod_8h.html#a2f7c3f3e1623c9774596d1ef68789171">icalperiodtype_as_ical_string_r</a>(period);</div> +<div class="line"><span class="keyword">const</span> <span class="keywordtype">char</span> *period_string_gen = <a class="code" href="icalperiod_8h.html#ac71be7790d778145a59ad9626458ccd5">icalperiodtype_as_ical_string_r</a>(period);</div> <div class="line">printf(<span class="stringliteral">"%s\n"</span>, period_string_gen);</div> -<div class="line"><a class="code hl_function" href="icalmemory_8h.html#a2f164cb87c67f06b5dc04a5f21384879">icalmemory_free_buffer</a>(period_string_gen);</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 class="ttc" id="aicalperiod_8h_html_a2f7c3f3e1623c9774596d1ef68789171"><div class="ttname"><a href="icalperiod_8h.html#a2f7c3f3e1623c9774596d1ef68789171">icalperiodtype_as_ical_string_r</a></div><div class="ttdeci">char * icalperiodtype_as_ical_string_r(struct icalperiodtype p)</div><div class="ttdoc">Converts an icalperiodtype into an iCal-formatted string.</div><div class="ttdef"><b>Definition:</b> icalperiod.c:94</div></div> +<div class="line"><a class="code" href="icalmemory_8h.html#a2f164cb87c67f06b5dc04a5f21384879">icalmemory_free_buffer</a>(period_string_gen);</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:287</div></div> +<div class="ttc" id="aicalperiod_8h_html_ac71be7790d778145a59ad9626458ccd5"><div class="ttname"><a href="icalperiod_8h.html#ac71be7790d778145a59ad9626458ccd5">icalperiodtype_as_ical_string_r</a></div><div class="ttdeci">char * icalperiodtype_as_ical_string_r(struct icalperiodtype p)</div><div class="ttdoc">Converts an icalperiodtype into an iCal-formatted string.</div><div class="ttdef"><b>Definition:</b> icalperiod.c:103</div></div> </div><!-- fragment --> </dd></dl> </div> </div> -<a id="a827e35abf4d6349e15aeaa9a483064fd" name="a827e35abf4d6349e15aeaa9a483064fd"></a> +<a id="a827e35abf4d6349e15aeaa9a483064fd"></a> <h2 class="memtitle"><span class="permalink"><a href="#a827e35abf4d6349e15aeaa9a483064fd">◆ </a></span>icalperiodtype_from_string()</h2> <div class="memitem"> @@ -246,15 +247,15 @@ Functions</h2></td></tr> <p>The format for the times is the same as those used by <a class="el" href="icaltime_8h.html#a1b66b9f52a9823b95e4cd33f9dd9b8e5" title="Constructor.">icaltime_from_string()</a>, and the format for the duration is the same as that used by <a class="el" href="icalduration_8h.html#a0d6d8cc773e19242448eaffb1368fef4" title="Creates a new icaldurationtype from a duration given as a string.">icaldurationtype_from_string()</a>.</p> <dl class="section user"><dt>Usage</dt><dd><div class="fragment"><div class="line"><span class="comment">// create icalperiodtype</span></div> <div class="line"><span class="keyword">const</span> <span class="keywordtype">char</span> *period_string = <span class="stringliteral">"20170606T090000/20170607T090000"</span>;</div> -<div class="line"><span class="keyword">struct </span><a class="code hl_struct" href="structicalperiodtype.html">icalperiodtype</a> period = <a class="code hl_function" href="icalperiod_8h.html#a827e35abf4d6349e15aeaa9a483064fd">icalperiodtype_from_string</a>(period_string);</div> +<div class="line"><span class="keyword">struct </span><a class="code" href="structicalperiodtype.html">icalperiodtype</a> period = <a class="code" href="icalperiod_8h.html#a827e35abf4d6349e15aeaa9a483064fd">icalperiodtype_from_string</a>(period_string);</div> <div class="line"> </div> <div class="line"><span class="comment">// print period in iCal format</span></div> -<div class="line">printf(<span class="stringliteral">"%s\n"</span>, <a class="code hl_function" href="icalperiod_8h.html#a28a5aa968b36182e39d7f3fd3491ecb3">icalperiodtype_as_ical_string</a>(period));</div> +<div class="line">printf(<span class="stringliteral">"%s\n"</span>, <a class="code" href="icalperiod_8h.html#ac84e7fc00fa25286c1f109eb35a10883">icalperiodtype_as_ical_string</a>(period));</div> </div><!-- fragment --> </dd></dl> </div> </div> -<a id="ae184bb1351602b7763044c5167a96bdf" name="ae184bb1351602b7763044c5167a96bdf"></a> +<a id="ae184bb1351602b7763044c5167a96bdf"></a> <h2 class="memtitle"><span class="permalink"><a href="#ae184bb1351602b7763044c5167a96bdf">◆ </a></span>icalperiodtype_is_null_period()</h2> <div class="memitem"> @@ -269,7 +270,7 @@ Functions</h2></td></tr> </tr> </table> </div><div class="memdoc"> -<p >Checks if a given <a class="el" href="structicalperiodtype.html" title="Struct to represent a period in time.">icalperiodtype</a> is a null period. </p><dl class="params"><dt>Parameters</dt><dd> +<p>Checks if a given <a class="el" href="structicalperiodtype.html" title="Struct to represent a period in time.">icalperiodtype</a> is a null period. </p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">p</td><td>The time period to check </td></tr> </table> @@ -278,17 +279,17 @@ Functions</h2></td></tr> <dl class="section return"><dt>Returns</dt><dd>1 if <em>p</em> is a null period, 0 otherwise </dd></dl> <dl class="section see"><dt>See also</dt><dd><a class="el" href="icalperiod_8h.html#a60e59a9f46a1efa9885829a4d23eddfa">icalperiodtype_null_period()</a></dd></dl> <dl class="section user"><dt>Usage</dt><dd><div class="fragment"><div class="line"><span class="comment">// creates null period</span></div> -<div class="line"><span class="keyword">struct </span><a class="code hl_struct" href="structicalperiodtype.html">icalperiodtype</a> period = <a class="code hl_function" href="icalperiod_8h.html#a60e59a9f46a1efa9885829a4d23eddfa">icalperiodtype_null_period</a>();</div> +<div class="line"><span class="keyword">struct </span><a class="code" href="structicalperiodtype.html">icalperiodtype</a> period = <a class="code" href="icalperiod_8h.html#a60e59a9f46a1efa9885829a4d23eddfa">icalperiodtype_null_period</a>();</div> <div class="line"> </div> <div class="line"><span class="comment">// checks if it's a null period</span></div> -<div class="line">assert(<a class="code hl_function" href="icalperiod_8h.html#ae184bb1351602b7763044c5167a96bdf">icalperiodtype_is_null_period</a>(period));</div> -<div class="ttc" id="aicalperiod_8h_html_a60e59a9f46a1efa9885829a4d23eddfa"><div class="ttname"><a href="icalperiod_8h.html#a60e59a9f46a1efa9885829a4d23eddfa">icalperiodtype_null_period</a></div><div class="ttdeci">struct icalperiodtype icalperiodtype_null_period(void)</div><div class="ttdef"><b>Definition:</b> icalperiod.c:124</div></div> -<div class="ttc" id="aicalperiod_8h_html_ae184bb1351602b7763044c5167a96bdf"><div class="ttname"><a href="icalperiod_8h.html#ae184bb1351602b7763044c5167a96bdf">icalperiodtype_is_null_period</a></div><div class="ttdeci">int icalperiodtype_is_null_period(struct icalperiodtype p)</div><div class="ttdef"><b>Definition:</b> icalperiod.c:135</div></div> +<div class="line">assert(<a class="code" href="icalperiod_8h.html#ae184bb1351602b7763044c5167a96bdf">icalperiodtype_is_null_period</a>(period));</div> +<div class="ttc" id="aicalperiod_8h_html_a60e59a9f46a1efa9885829a4d23eddfa"><div class="ttname"><a href="icalperiod_8h.html#a60e59a9f46a1efa9885829a4d23eddfa">icalperiodtype_null_period</a></div><div class="ttdeci">struct icalperiodtype icalperiodtype_null_period(void)</div><div class="ttdef"><b>Definition:</b> icalperiod.c:133</div></div> +<div class="ttc" id="aicalperiod_8h_html_ae184bb1351602b7763044c5167a96bdf"><div class="ttname"><a href="icalperiod_8h.html#ae184bb1351602b7763044c5167a96bdf">icalperiodtype_is_null_period</a></div><div class="ttdeci">int icalperiodtype_is_null_period(struct icalperiodtype p)</div><div class="ttdef"><b>Definition:</b> icalperiod.c:144</div></div> </div><!-- fragment --> </dd></dl> </div> </div> -<a id="af7feaf12370cd37d66d160c4d8fbf0c7" name="af7feaf12370cd37d66d160c4d8fbf0c7"></a> +<a id="af7feaf12370cd37d66d160c4d8fbf0c7"></a> <h2 class="memtitle"><span class="permalink"><a href="#af7feaf12370cd37d66d160c4d8fbf0c7">◆ </a></span>icalperiodtype_is_valid_period()</h2> <div class="memitem"> @@ -303,7 +304,7 @@ Functions</h2></td></tr> </tr> </table> </div><div class="memdoc"> -<p >Checks if a given <a class="el" href="structicalperiodtype.html" title="Struct to represent a period in time.">icalperiodtype</a> is a valid period. </p><dl class="params"><dt>Parameters</dt><dd> +<p>Checks if a given <a class="el" href="structicalperiodtype.html" title="Struct to represent a period in time.">icalperiodtype</a> is a valid period. </p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">p</td><td>The time period to check </td></tr> </table> @@ -311,16 +312,16 @@ Functions</h2></td></tr> </dl> <dl class="section return"><dt>Returns</dt><dd>1 if <em>p</em> is a valid period, 0 otherwise</dd></dl> <dl class="section user"><dt>Usage</dt><dd><div class="fragment"><div class="line"><span class="comment">// creates null period</span></div> -<div class="line"><span class="keyword">struct </span><a class="code hl_struct" href="structicalperiodtype.html">icalperiodtype</a> period = <a class="code hl_function" href="icalperiod_8h.html#a60e59a9f46a1efa9885829a4d23eddfa">icalperiodtype_null_period</a>();</div> +<div class="line"><span class="keyword">struct </span><a class="code" href="structicalperiodtype.html">icalperiodtype</a> period = <a class="code" href="icalperiod_8h.html#a60e59a9f46a1efa9885829a4d23eddfa">icalperiodtype_null_period</a>();</div> <div class="line"> </div> <div class="line"><span class="comment">// a null period isn't a valid period</span></div> -<div class="line">assert(<a class="code hl_function" href="icalperiod_8h.html#af7feaf12370cd37d66d160c4d8fbf0c7">icalperiodtype_is_valid_period</a>(period) == 0);</div> -<div class="ttc" id="aicalperiod_8h_html_af7feaf12370cd37d66d160c4d8fbf0c7"><div class="ttname"><a href="icalperiod_8h.html#af7feaf12370cd37d66d160c4d8fbf0c7">icalperiodtype_is_valid_period</a></div><div class="ttdeci">int icalperiodtype_is_valid_period(struct icalperiodtype p)</div><div class="ttdef"><b>Definition:</b> icalperiod.c:145</div></div> +<div class="line">assert(<a class="code" href="icalperiod_8h.html#af7feaf12370cd37d66d160c4d8fbf0c7">icalperiodtype_is_valid_period</a>(period) == 0);</div> +<div class="ttc" id="aicalperiod_8h_html_af7feaf12370cd37d66d160c4d8fbf0c7"><div class="ttname"><a href="icalperiod_8h.html#af7feaf12370cd37d66d160c4d8fbf0c7">icalperiodtype_is_valid_period</a></div><div class="ttdeci">int icalperiodtype_is_valid_period(struct icalperiodtype p)</div><div class="ttdef"><b>Definition:</b> icalperiod.c:154</div></div> </div><!-- fragment --> </dd></dl> </div> </div> -<a id="a60e59a9f46a1efa9885829a4d23eddfa" name="a60e59a9f46a1efa9885829a4d23eddfa"></a> +<a id="a60e59a9f46a1efa9885829a4d23eddfa"></a> <h2 class="memtitle"><span class="permalink"><a href="#a60e59a9f46a1efa9885829a4d23eddfa">◆ </a></span>icalperiodtype_null_period()</h2> <div class="memitem"> @@ -335,16 +336,16 @@ Functions</h2></td></tr> </tr> </table> </div><div class="memdoc"> -<p >Creates a null period <a class="el" href="structicalperiodtype.html" title="Struct to represent a period in time.">icalperiodtype</a>. </p><dl class="section return"><dt>Returns</dt><dd>An <a class="el" href="structicalperiodtype.html" title="Struct to represent a period in time.">icalperiodtype</a> representing a null period </dd></dl> +<p>Creates a null period <a class="el" href="structicalperiodtype.html" title="Struct to represent a period in time.">icalperiodtype</a>. </p><dl class="section return"><dt>Returns</dt><dd>An <a class="el" href="structicalperiodtype.html" title="Struct to represent a period in time.">icalperiodtype</a> representing a null period </dd></dl> <dl class="section see"><dt>See also</dt><dd><a class="el" href="icalperiod_8h.html#ae184bb1351602b7763044c5167a96bdf">icalperiodtype_is_null_period()</a></dd></dl> <dl class="section user"><dt>Usage</dt><dd><div class="fragment"><div class="line"><span class="comment">// creates null period</span></div> -<div class="line"><span class="keyword">struct </span><a class="code hl_struct" href="structicalperiodtype.html">icalperiodtype</a> period = <a class="code hl_function" href="icalperiod_8h.html#a60e59a9f46a1efa9885829a4d23eddfa">icalperiodtype_null_period</a>();</div> +<div class="line"><span class="keyword">struct </span><a class="code" href="structicalperiodtype.html">icalperiodtype</a> period = <a class="code" href="icalperiod_8h.html#a60e59a9f46a1efa9885829a4d23eddfa">icalperiodtype_null_period</a>();</div> <div class="line"> </div> <div class="line"><span class="comment">// verifies start, end and length</span></div> -<div class="line">assert(<a class="code hl_function" href="icaltime_8h.html#a97483d9daf2fc8f8b1bbdc0c75ced095">icaltime_is_null_time</a>(period.start));</div> -<div class="line">assert(<a class="code hl_function" href="icaltime_8h.html#a97483d9daf2fc8f8b1bbdc0c75ced095">icaltime_is_null_time</a>(period.end));</div> +<div class="line">assert(<a class="code" href="icaltime_8h.html#a97483d9daf2fc8f8b1bbdc0c75ced095">icaltime_is_null_time</a>(period.start));</div> +<div class="line">assert(<a class="code" href="icaltime_8h.html#a97483d9daf2fc8f8b1bbdc0c75ced095">icaltime_is_null_time</a>(period.end));</div> <div class="line">assert(icaldurationtype_is_null_duratino(period.duration));</div> -<div class="ttc" id="aicaltime_8h_html_a97483d9daf2fc8f8b1bbdc0c75ced095"><div class="ttname"><a href="icaltime_8h.html#a97483d9daf2fc8f8b1bbdc0c75ced095">icaltime_is_null_time</a></div><div class="ttdeci">int icaltime_is_null_time(const struct icaltimetype t)</div><div class="ttdoc">Returns true if the time is null.</div><div class="ttdef"><b>Definition:</b> icaltime.c:593</div></div> +<div class="ttc" id="aicaltime_8h_html_a97483d9daf2fc8f8b1bbdc0c75ced095"><div class="ttname"><a href="icaltime_8h.html#a97483d9daf2fc8f8b1bbdc0c75ced095">icaltime_is_null_time</a></div><div class="ttdeci">int icaltime_is_null_time(const struct icaltimetype t)</div><div class="ttdoc">Returns true if the time is null.</div><div class="ttdef"><b>Definition:</b> icaltime.c:617</div></div> </div><!-- fragment --> </dd></dl> </div> @@ -352,7 +353,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> |