diff options
Diffstat (limited to 'apidocs/icalduration_8h.html')
| -rw-r--r-- | apidocs/icalduration_8h.html | 164 |
1 files changed, 81 insertions, 83 deletions
diff --git a/apidocs/icalduration_8h.html b/apidocs/icalduration_8h.html index 76c50810..1e6cab5d 100644 --- a/apidocs/icalduration_8h.html +++ b/apidocs/icalduration_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=9"/> -<meta name="generator" content="Doxygen 1.9.1"/> +<meta http-equiv="X-UA-Compatible" content="IE=11"/> +<meta name="generator" content="Doxygen 1.9.3"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>Libical API Documentation: icalduration.h File Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> @@ -19,10 +19,9 @@ <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> - <tr style="height: 56px;"> - <td id="projectalign" style="padding-left: 0.5em;"> - <div id="projectname">Libical API Documentation -  <span id="projectnumber">3.1</span> + <tr id="projectrow"> + <td id="projectalign"> + <div id="projectname">Libical API Documentation<span id="projectnumber"> 3.0</span> </div> </td> </tr> @@ -30,21 +29,22 @@ </table> </div> <!-- end header part --> -<!-- Generated by Doxygen 1.9.1 --> +<!-- Generated by Doxygen 1.9.3 --> <script type="text/javascript"> -/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ -var searchBox = new SearchBox("searchBox", "search",false,'Search','.html'); +/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ +var searchBox = new SearchBox("searchBox", "search",'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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ +/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ $(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,8 +70,7 @@ $(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">icalduration.h File Reference</div> </div> + <div class="headertitle"><div class="title">icalduration.h File Reference</div></div> </div><!--header--> <div class="contents"> @@ -80,24 +79,24 @@ $(function() { <p><a href="icalduration_8h_source.html">Go to the source code of this file.</a></p> <table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" 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="structicaldurationtype.html">icaldurationtype</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A struct representing a duration. <a href="structicaldurationtype.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 name="define-members"></a> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a> Macros</h2></td></tr> -<tr class="memitem:ae903a80c43b72c1f157d7709e08d05ae"><td class="memItemLeft" align="right" valign="top"><a id="ae903a80c43b72c1f157d7709e08d05ae"></a> +<tr class="memitem:ae903a80c43b72c1f157d7709e08d05ae"><td class="memItemLeft" align="right" valign="top"><a id="ae903a80c43b72c1f157d7709e08d05ae" name="ae903a80c43b72c1f157d7709e08d05ae"></a> #define </td><td class="memItemRight" valign="bottom"><b>ICALDURATIONTYPE_INITIALIZER</b>   { 0, 0, 0, 0, 0, 0 }</td></tr> <tr class="separator:ae903a80c43b72c1f157d7709e08d05ae"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a> Functions</h2></td></tr> -<tr class="memitem:a7ebae580ab5bab4e9ffe822ff1dee9c8"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalduration_8h.html#a7ebae580ab5bab4e9ffe822ff1dee9c8">icaldurationtype_as_ical_string</a> (struct <a class="el" href="structicaldurationtype.html">icaldurationtype</a> d)</td></tr> -<tr class="separator:a7ebae580ab5bab4e9ffe822ff1dee9c8"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a758d27dc5433c570f5ea5995c5001e79"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalduration_8h.html#a758d27dc5433c570f5ea5995c5001e79">icaldurationtype_as_ical_string_r</a> (struct <a class="el" href="structicaldurationtype.html">icaldurationtype</a> d)</td></tr> -<tr class="separator:a758d27dc5433c570f5ea5995c5001e79"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:adb753c6f52d493cfa9f31c2d7730ace1"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalduration_8h.html#adb753c6f52d493cfa9f31c2d7730ace1">icaldurationtype_as_ical_string</a> (struct <a class="el" href="structicaldurationtype.html">icaldurationtype</a> d)</td></tr> +<tr class="separator:adb753c6f52d493cfa9f31c2d7730ace1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ab87c9958f888dba23afa2249110ca137"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalduration_8h.html#ab87c9958f888dba23afa2249110ca137">icaldurationtype_as_ical_string_r</a> (struct <a class="el" href="structicaldurationtype.html">icaldurationtype</a> d)</td></tr> +<tr class="separator:ab87c9958f888dba23afa2249110ca137"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1828c484b9efb3cb1f08ec5eb58c7a18"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="icalduration_8h.html#a1828c484b9efb3cb1f08ec5eb58c7a18">icaldurationtype_as_int</a> (struct <a class="el" href="structicaldurationtype.html">icaldurationtype</a> duration)</td></tr> <tr class="memdesc:a1828c484b9efb3cb1f08ec5eb58c7a18"><td class="mdescLeft"> </td><td class="mdescRight">Converts an <a class="el" href="structicaldurationtype.html" title="A struct representing a duration.">icaldurationtype</a> into the duration in seconds as <code>int</code>. <a href="icalduration_8h.html#a1828c484b9efb3cb1f08ec5eb58c7a18">More...</a><br /></td></tr> <tr class="separator:a1828c484b9efb3cb1f08ec5eb58c7a18"><td class="memSeparator" colspan="2"> </td></tr> @@ -127,16 +126,16 @@ Functions</h2></td></tr> <tr class="separator:aaafcb16e5d2aaa6eb0e20fdac419fc0d"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> -<div class="textblock"><p>Methods for working with durations in iCal. </p> +<div class="textblock"><p >Methods for working with durations in iCal. </p> </div><h2 class="groupheader">Function Documentation</h2> -<a id="a7ebae580ab5bab4e9ffe822ff1dee9c8"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a7ebae580ab5bab4e9ffe822ff1dee9c8">◆ </a></span>icaldurationtype_as_ical_string()</h2> +<a id="adb753c6f52d493cfa9f31c2d7730ace1" name="adb753c6f52d493cfa9f31c2d7730ace1"></a> +<h2 class="memtitle"><span class="permalink"><a href="#adb753c6f52d493cfa9f31c2d7730ace1">◆ </a></span>icaldurationtype_as_ical_string()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">char* icaldurationtype_as_ical_string </td> + <td class="memname">char * icaldurationtype_as_ical_string </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structicaldurationtype.html">icaldurationtype</a> </td> <td class="paramname"><em>d</em></td><td>)</td> @@ -144,40 +143,39 @@ Functions</h2></td></tr> </tr> </table> </div><div class="memdoc"> -<p>Converts an icaldurationtype into the iCal format as string. </p><dl class="params"><dt>Parameters</dt><dd> +<p >Converts an icaldurationtype into the iCal format as string. </p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">The</td><td>icaldurationtype to convert to iCal format </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>A string representing duration <code>d</code> in iCal format </dd></dl> -<dl class="section see"><dt>See also</dt><dd><a class="el" href="icalduration_8h.html#a758d27dc5433c570f5ea5995c5001e79">icaldurationtype_as_ical_string_r()</a></dd></dl> -<p><b>Ownership</b> The string returned by this function is owned by the caller and needs to be released with <code><a class="el" href="icalmemory_8h.html#a2f164cb87c67f06b5dc04a5f21384879" title="Releases a buffer.">icalmemory_free_buffer()</a></code> after it's no longer needed.</p> -<p><b>Usage</b> </p><div class="fragment"><div class="line"><span class="comment">// create new duration</span></div> -<div class="line"><span class="keyword">struct </span><a class="code" href="structicaldurationtype.html">icaldurationtype</a> duration;</div> -<div class="line">duration = <a class="code" href="icalduration_8h.html#a88157a8ae61263ea15af92a416889301">icaldurationtype_from_int</a>(3424224);</div> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="icalduration_8h.html#ab87c9958f888dba23afa2249110ca137">icaldurationtype_as_ical_string_r()</a></dd></dl> +<p><b>Ownership</b> The string returned by this function is owned by the caller and needs to be released with <code>free()</code> after it's no longer needed.</p> +<p ><b>Usage</b> </p><div class="fragment"><div class="line"><span class="comment">// create new duration</span></div> +<div class="line"><span class="keyword">struct </span><a class="code hl_struct" href="structicaldurationtype.html">icaldurationtype</a> duration;</div> +<div class="line">duration = <a class="code hl_function" href="icalduration_8h.html#a88157a8ae61263ea15af92a416889301">icaldurationtype_from_int</a>(3424224);</div> <div class="line"> </div> <div class="line"><span class="comment">// print as ical-formatted string</span></div> -<div class="line"><span class="keywordtype">char</span> *ical = <a class="code" href="icalduration_8h.html#a7ebae580ab5bab4e9ffe822ff1dee9c8">icaldurationtype_as_ical_string</a>(duration);</div> +<div class="line"><span class="keywordtype">char</span> *ical = <a class="code hl_function" href="icalduration_8h.html#adb753c6f52d493cfa9f31c2d7730ace1">icaldurationtype_as_ical_string</a>(duration);</div> <div class="line">printf(<span class="stringliteral">"%s\n"</span>, ical);</div> <div class="line"> </div> <div class="line"><span class="comment">// release string</span></div> -<div class="line"><a class="code" href="icalmemory_8h.html#a2f164cb87c67f06b5dc04a5f21384879">icalmemory_free_buffer</a>(ical);</div> -<div class="ttc" id="aicalduration_8h_html_a7ebae580ab5bab4e9ffe822ff1dee9c8"><div class="ttname"><a href="icalduration_8h.html#a7ebae580ab5bab4e9ffe822ff1dee9c8">icaldurationtype_as_ical_string</a></div><div class="ttdeci">char * icaldurationtype_as_ical_string(struct icaldurationtype d)</div><div class="ttdef"><b>Definition:</b> icalduration.c:211</div></div> +<div class="line">free(ical);</div> <div class="ttc" id="aicalduration_8h_html_a88157a8ae61263ea15af92a416889301"><div class="ttname"><a href="icalduration_8h.html#a88157a8ae61263ea15af92a416889301">icaldurationtype_from_int</a></div><div class="ttdeci">struct icaldurationtype icaldurationtype_from_int(int t)</div><div class="ttdoc">Creates a new icaldurationtype from a duration in seconds.</div><div class="ttdef"><b>Definition:</b> icalduration.c:32</div></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:379</div></div> +<div class="ttc" id="aicalduration_8h_html_adb753c6f52d493cfa9f31c2d7730ace1"><div class="ttname"><a href="icalduration_8h.html#adb753c6f52d493cfa9f31c2d7730ace1">icaldurationtype_as_ical_string</a></div><div class="ttdeci">char * icaldurationtype_as_ical_string(struct icaldurationtype d)</div><div class="ttdef"><b>Definition:</b> icalduration.c:211</div></div> <div class="ttc" id="astructicaldurationtype_html"><div class="ttname"><a href="structicaldurationtype.html">icaldurationtype</a></div><div class="ttdoc">A struct representing a duration.</div><div class="ttdef"><b>Definition:</b> icalduration.h:37</div></div> </div><!-- fragment --> </div> </div> -<a id="a758d27dc5433c570f5ea5995c5001e79"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a758d27dc5433c570f5ea5995c5001e79">◆ </a></span>icaldurationtype_as_ical_string_r()</h2> +<a id="ab87c9958f888dba23afa2249110ca137" name="ab87c9958f888dba23afa2249110ca137"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ab87c9958f888dba23afa2249110ca137">◆ </a></span>icaldurationtype_as_ical_string_r()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">char* icaldurationtype_as_ical_string_r </td> + <td class="memname">char * icaldurationtype_as_ical_string_r </td> <td>(</td> <td class="paramtype">struct <a class="el" href="structicaldurationtype.html">icaldurationtype</a> </td> <td class="paramname"><em>d</em></td><td>)</td> @@ -185,25 +183,25 @@ Functions</h2></td></tr> </tr> </table> </div><div class="memdoc"> -<p>Converts an icaldurationtype into the iCal format as string. </p><dl class="params"><dt>Parameters</dt><dd> +<p >Converts an icaldurationtype into the iCal format as string. </p><dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">The</td><td>icaldurationtype to convert to iCal format </td></tr> </table> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>A string representing duration <code>d</code> in iCal format </dd></dl> -<dl class="section see"><dt>See also</dt><dd><a class="el" href="icalduration_8h.html#a7ebae580ab5bab4e9ffe822ff1dee9c8">icaldurationtype_as_ical_string()</a></dd></dl> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="icalduration_8h.html#adb753c6f52d493cfa9f31c2d7730ace1">icaldurationtype_as_ical_string()</a></dd></dl> <p><b>Ownership</b> The string returned by this function is owned by libical and must not be released by the caller of the function.</p> -<p><b>Usage</b> </p><div class="fragment"><div class="line"><span class="comment">// create new duration</span></div> -<div class="line"><span class="keyword">struct </span><a class="code" href="structicaldurationtype.html">icaldurationtype</a> duration;</div> -<div class="line">duration = <a class="code" href="icalduration_8h.html#a88157a8ae61263ea15af92a416889301">icaldurationtype_from_int</a>(3424224);</div> +<p ><b>Usage</b> </p><div class="fragment"><div class="line"><span class="comment">// create new duration</span></div> +<div class="line"><span class="keyword">struct </span><a class="code hl_struct" href="structicaldurationtype.html">icaldurationtype</a> duration;</div> +<div class="line">duration = <a class="code hl_function" href="icalduration_8h.html#a88157a8ae61263ea15af92a416889301">icaldurationtype_from_int</a>(3424224);</div> <div class="line"> </div> <div class="line"><span class="comment">// print as ical-formatted string</span></div> -<div class="line">printf(<span class="stringliteral">"%s\n"</span>, <a class="code" href="icalduration_8h.html#a7ebae580ab5bab4e9ffe822ff1dee9c8">icaldurationtype_as_ical_string</a>(duration));</div> +<div class="line">printf(<span class="stringliteral">"%s\n"</span>, <a class="code hl_function" href="icalduration_8h.html#adb753c6f52d493cfa9f31c2d7730ace1">icaldurationtype_as_ical_string</a>(duration));</div> </div><!-- fragment --> </div> </div> -<a id="a1828c484b9efb3cb1f08ec5eb58c7a18"></a> +<a id="a1828c484b9efb3cb1f08ec5eb58c7a18" name="a1828c484b9efb3cb1f08ec5eb58c7a18"></a> <h2 class="memtitle"><span class="permalink"><a href="#a1828c484b9efb3cb1f08ec5eb58c7a18">◆ </a></span>icaldurationtype_as_int()</h2> <div class="memitem"> @@ -230,16 +228,16 @@ Functions</h2></td></tr> <h3><a class="anchor" id="autotoc_md13"></a> Usage</h3> <div class="fragment"><div class="line"><span class="comment">// create icaldurationtype with given duration</span></div> -<div class="line"><span class="keyword">struct </span><a class="code" href="structicaldurationtype.html">icaldurationtype</a> duration;</div> -<div class="line">duration = <a class="code" href="icalduration_8h.html#a88157a8ae61263ea15af92a416889301">icaldurationtype_from_int</a>(3532342);</div> +<div class="line"><span class="keyword">struct </span><a class="code hl_struct" href="structicaldurationtype.html">icaldurationtype</a> duration;</div> +<div class="line">duration = <a class="code hl_function" href="icalduration_8h.html#a88157a8ae61263ea15af92a416889301">icaldurationtype_from_int</a>(3532342);</div> <div class="line"> </div> <div class="line"><span class="comment">// get the duration in seconds and verify it</span></div> -<div class="line">assert(<a class="code" href="icalduration_8h.html#a1828c484b9efb3cb1f08ec5eb58c7a18">icaldurationtype_as_int</a>(duration) == 3532342);</div> -<div class="ttc" id="aicalduration_8h_html_a1828c484b9efb3cb1f08ec5eb58c7a18"><div class="ttname"><a href="icalduration_8h.html#a1828c484b9efb3cb1f08ec5eb58c7a18">icaldurationtype_as_int</a></div><div class="ttdeci">int icaldurationtype_as_int(struct icaldurationtype duration)</div><div class="ttdoc">Converts an icaldurationtype into the duration in seconds as int.</div><div class="ttdef"><b>Definition:</b> icalduration.c:269</div></div> +<div class="line">assert(<a class="code hl_function" href="icalduration_8h.html#a1828c484b9efb3cb1f08ec5eb58c7a18">icaldurationtype_as_int</a>(duration) == 3532342);</div> +<div class="ttc" id="aicalduration_8h_html_a1828c484b9efb3cb1f08ec5eb58c7a18"><div class="ttname"><a href="icalduration_8h.html#a1828c484b9efb3cb1f08ec5eb58c7a18">icaldurationtype_as_int</a></div><div class="ttdeci">int icaldurationtype_as_int(struct icaldurationtype duration)</div><div class="ttdoc">Converts an icaldurationtype into the duration in seconds as int.</div><div class="ttdef"><b>Definition:</b> icalduration.c:270</div></div> </div><!-- fragment --> </div> </div> -<a id="a2578535a23fc5c6d4d61c09c880f03fd"></a> +<a id="a2578535a23fc5c6d4d61c09c880f03fd" name="a2578535a23fc5c6d4d61c09c880f03fd"></a> <h2 class="memtitle"><span class="permalink"><a href="#a2578535a23fc5c6d4d61c09c880f03fd">◆ </a></span>icaldurationtype_bad_duration()</h2> <div class="memitem"> @@ -261,17 +259,17 @@ Usage</h3> <h3><a class="anchor" id="autotoc_md15"></a> Usage</h3> <div class="fragment"><div class="line"><span class="comment">// create bad duration</span></div> -<div class="line"><span class="keyword">struct </span><a class="code" href="structicaldurationtype.html">icaldurationtype</a> duration;</div> -<div class="line">duration = <a class="code" href="icalduration_8h.html#a2578535a23fc5c6d4d61c09c880f03fd">icaldurationtype_bad_duration</a>();</div> +<div class="line"><span class="keyword">struct </span><a class="code hl_struct" href="structicaldurationtype.html">icaldurationtype</a> duration;</div> +<div class="line">duration = <a class="code hl_function" href="icalduration_8h.html#a2578535a23fc5c6d4d61c09c880f03fd">icaldurationtype_bad_duration</a>();</div> <div class="line"> </div> <div class="line"><span class="comment">// make sure it's bad</span></div> -<div class="line">assert(<a class="code" href="icalduration_8h.html#a88c5b90b57f9e1f79c00a544746687d6">icaldurationtype_is_bad_duration</a>(duration));</div> +<div class="line">assert(<a class="code hl_function" href="icalduration_8h.html#a88c5b90b57f9e1f79c00a544746687d6">icaldurationtype_is_bad_duration</a>(duration));</div> <div class="ttc" id="aicalduration_8h_html_a2578535a23fc5c6d4d61c09c880f03fd"><div class="ttname"><a href="icalduration_8h.html#a2578535a23fc5c6d4d61c09c880f03fd">icaldurationtype_bad_duration</a></div><div class="ttdeci">struct icaldurationtype icaldurationtype_bad_duration(void)</div><div class="ttdoc">Creates a bad duration (used to indicate error).</div><div class="ttdef"><b>Definition:</b> icalduration.c:304</div></div> <div class="ttc" id="aicalduration_8h_html_a88c5b90b57f9e1f79c00a544746687d6"><div class="ttname"><a href="icalduration_8h.html#a88c5b90b57f9e1f79c00a544746687d6">icaldurationtype_is_bad_duration</a></div><div class="ttdeci">int icaldurationtype_is_bad_duration(struct icaldurationtype d)</div><div class="ttdoc">Checks if a duration is a bad duration.</div><div class="ttdef"><b>Definition:</b> icalduration.c:313</div></div> </div><!-- fragment --> </div> </div> -<a id="a88157a8ae61263ea15af92a416889301"></a> +<a id="a88157a8ae61263ea15af92a416889301" name="a88157a8ae61263ea15af92a416889301"></a> <h2 class="memtitle"><span class="permalink"><a href="#a88157a8ae61263ea15af92a416889301">◆ </a></span>icaldurationtype_from_int()</h2> <div class="memitem"> @@ -298,15 +296,15 @@ Usage</h3> <h3><a class="anchor" id="autotoc_md11"></a> Example</h3> <div class="fragment"><div class="line"><span class="comment">// create a new icaldurationtype with a duration of 60 seconds</span></div> -<div class="line"><span class="keyword">struct </span><a class="code" href="structicaldurationtype.html">icaldurationtype</a> duration;</div> -<div class="line">duration = <a class="code" href="icalduration_8h.html#a88157a8ae61263ea15af92a416889301">icaldurationtype_from_int</a>(60);</div> +<div class="line"><span class="keyword">struct </span><a class="code hl_struct" href="structicaldurationtype.html">icaldurationtype</a> duration;</div> +<div class="line">duration = <a class="code hl_function" href="icalduration_8h.html#a88157a8ae61263ea15af92a416889301">icaldurationtype_from_int</a>(60);</div> <div class="line"> </div> <div class="line"><span class="comment">// verify that the duration is one minute</span></div> <div class="line">assert(duration.minutes == 1);</div> </div><!-- fragment --> </div> </div> -<a id="a0d6d8cc773e19242448eaffb1368fef4"></a> +<a id="a0d6d8cc773e19242448eaffb1368fef4" name="a0d6d8cc773e19242448eaffb1368fef4"></a> <h2 class="memtitle"><span class="permalink"><a href="#a0d6d8cc773e19242448eaffb1368fef4">◆ </a></span>icaldurationtype_from_string()</h2> <div class="memitem"> @@ -334,8 +332,8 @@ Example</h3> <h3><a class="anchor" id="autotoc_md12"></a> Usage</h3> <div class="fragment"><div class="line"><span class="comment">// create a new icaldurationtype</span></div> -<div class="line"><span class="keyword">struct </span><a class="code" href="structicaldurationtype.html">icaldurationtype</a> duration;</div> -<div class="line">duration = <a class="code" href="icalduration_8h.html#a0d6d8cc773e19242448eaffb1368fef4">icaldurationtype_from_string</a>(<span class="stringliteral">"+PT05M"</span>);</div> +<div class="line"><span class="keyword">struct </span><a class="code hl_struct" href="structicaldurationtype.html">icaldurationtype</a> duration;</div> +<div class="line">duration = <a class="code hl_function" href="icalduration_8h.html#a0d6d8cc773e19242448eaffb1368fef4">icaldurationtype_from_string</a>(<span class="stringliteral">"+PT05M"</span>);</div> <div class="line"> </div> <div class="line"><span class="comment">// verify that it's 5 minutes</span></div> <div class="line">assert(duration.minutes == 5);</div> @@ -343,7 +341,7 @@ Usage</h3> </div><!-- fragment --> </div> </div> -<a id="a88c5b90b57f9e1f79c00a544746687d6"></a> +<a id="a88c5b90b57f9e1f79c00a544746687d6" name="a88c5b90b57f9e1f79c00a544746687d6"></a> <h2 class="memtitle"><span class="permalink"><a href="#a88c5b90b57f9e1f79c00a544746687d6">◆ </a></span>icaldurationtype_is_bad_duration()</h2> <div class="memitem"> @@ -371,15 +369,15 @@ Usage</h3> <h3><a class="anchor" id="autotoc_md17"></a> Usage</h3> <div class="fragment"><div class="line"><span class="comment">// make bad duration</span></div> -<div class="line"><span class="keyword">struct </span><a class="code" href="structicaldurationtype.html">icaldurationtype</a> duration;</div> -<div class="line">duration = <a class="code" href="icalduration_8h.html#a2578535a23fc5c6d4d61c09c880f03fd">icaldurationtype_bad_duration</a>();</div> +<div class="line"><span class="keyword">struct </span><a class="code hl_struct" href="structicaldurationtype.html">icaldurationtype</a> duration;</div> +<div class="line">duration = <a class="code hl_function" href="icalduration_8h.html#a2578535a23fc5c6d4d61c09c880f03fd">icaldurationtype_bad_duration</a>();</div> <div class="line"> </div> <div class="line"><span class="comment">// check bad duration</span></div> -<div class="line">assert(<a class="code" href="icalduration_8h.html#a88c5b90b57f9e1f79c00a544746687d6">icaldurationtype_is_bad_duration</a>(duration));</div> +<div class="line">assert(<a class="code hl_function" href="icalduration_8h.html#a88c5b90b57f9e1f79c00a544746687d6">icaldurationtype_is_bad_duration</a>(duration));</div> </div><!-- fragment --> </div> </div> -<a id="afcdeddc439488d8f586db0702593c270"></a> +<a id="afcdeddc439488d8f586db0702593c270" name="afcdeddc439488d8f586db0702593c270"></a> <h2 class="memtitle"><span class="permalink"><a href="#afcdeddc439488d8f586db0702593c270">◆ </a></span>icaldurationtype_is_null_duration()</h2> <div class="memitem"> @@ -407,17 +405,17 @@ Usage</h3> <h3><a class="anchor" id="autotoc_md16"></a> Usage</h3> <div class="fragment"><div class="line"><span class="comment">// make null duration</span></div> -<div class="line"><span class="keyword">struct </span><a class="code" href="structicaldurationtype.html">icaldurationtype</a> duration;</div> -<div class="line">duration = <a class="code" href="icalduration_8h.html#ad716774a6570e0be2eb11868deb86595">icaldurationtype_null_duration</a>();</div> +<div class="line"><span class="keyword">struct </span><a class="code hl_struct" href="structicaldurationtype.html">icaldurationtype</a> duration;</div> +<div class="line">duration = <a class="code hl_function" href="icalduration_8h.html#ad716774a6570e0be2eb11868deb86595">icaldurationtype_null_duration</a>();</div> <div class="line"> </div> <div class="line"><span class="comment">// check null duration</span></div> -<div class="line">assert(<a class="code" href="icalduration_8h.html#afcdeddc439488d8f586db0702593c270">icaldurationtype_is_null_duration</a>(duration));</div> +<div class="line">assert(<a class="code hl_function" href="icalduration_8h.html#afcdeddc439488d8f586db0702593c270">icaldurationtype_is_null_duration</a>(duration));</div> <div class="ttc" id="aicalduration_8h_html_ad716774a6570e0be2eb11868deb86595"><div class="ttname"><a href="icalduration_8h.html#ad716774a6570e0be2eb11868deb86595">icaldurationtype_null_duration</a></div><div class="ttdeci">struct icaldurationtype icaldurationtype_null_duration(void)</div><div class="ttdoc">Creates a duration with zero length.</div><div class="ttdef"><b>Definition:</b> icalduration.c:279</div></div> <div class="ttc" id="aicalduration_8h_html_afcdeddc439488d8f586db0702593c270"><div class="ttname"><a href="icalduration_8h.html#afcdeddc439488d8f586db0702593c270">icaldurationtype_is_null_duration</a></div><div class="ttdeci">int icaldurationtype_is_null_duration(struct icaldurationtype d)</div><div class="ttdoc">Checks if a duration is a null duration.</div><div class="ttdef"><b>Definition:</b> icalduration.c:288</div></div> </div><!-- fragment --> </div> </div> -<a id="ad716774a6570e0be2eb11868deb86595"></a> +<a id="ad716774a6570e0be2eb11868deb86595" name="ad716774a6570e0be2eb11868deb86595"></a> <h2 class="memtitle"><span class="permalink"><a href="#ad716774a6570e0be2eb11868deb86595">◆ </a></span>icaldurationtype_null_duration()</h2> <div class="memitem"> @@ -439,8 +437,8 @@ Usage</h3> <h3><a class="anchor" id="autotoc_md14"></a> Usage</h3> <div class="fragment"><div class="line"><span class="comment">// create null duration</span></div> -<div class="line"><span class="keyword">struct </span><a class="code" href="structicaldurationtype.html">icaldurationtype</a> duration;</div> -<div class="line">duration = <a class="code" href="icalduration_8h.html#ad716774a6570e0be2eb11868deb86595">icaldurationtype_null_duration</a>();</div> +<div class="line"><span class="keyword">struct </span><a class="code hl_struct" href="structicaldurationtype.html">icaldurationtype</a> duration;</div> +<div class="line">duration = <a class="code hl_function" href="icalduration_8h.html#ad716774a6570e0be2eb11868deb86595">icaldurationtype_null_duration</a>();</div> <div class="line"> </div> <div class="line"><span class="comment">// make sure it's zero length</span></div> <div class="line">assert(duration.days == 0);</div> @@ -453,7 +451,7 @@ Usage</h3> </div><!-- fragment --> </div> </div> -<a id="aacc4e7db2c4b8dd96fd428edee73acf5"></a> +<a id="aacc4e7db2c4b8dd96fd428edee73acf5" name="aacc4e7db2c4b8dd96fd428edee73acf5"></a> <h2 class="memtitle"><span class="permalink"><a href="#aacc4e7db2c4b8dd96fd428edee73acf5">◆ </a></span>icaltime_add()</h2> <div class="memitem"> @@ -490,22 +488,22 @@ Usage</h3> <dl class="section return"><dt>Returns</dt><dd>The new <a class="el" href="structicaltimetype.html">icaltimetype</a> which has been added the duration to</dd></dl> <h3><a class="anchor" id="autotoc_md18"></a> Example</h3> -<div class="fragment"><div class="line"><span class="keyword">struct </span><a class="code" href="structicaltimetype.html">icaltimetype</a> time;</div> -<div class="line"><span class="keyword">struct </span><a class="code" href="structicaldurationtype.html">icaldurationtype</a> duration;</div> +<div class="fragment"><div class="line"><span class="keyword">struct </span><a class="code hl_struct" href="structicaltimetype.html">icaltimetype</a> time;</div> +<div class="line"><span class="keyword">struct </span><a class="code hl_struct" href="structicaldurationtype.html">icaldurationtype</a> duration;</div> <div class="line"> </div> <div class="line"><span class="comment">// create time and duration objects</span></div> -<div class="line">time = <a class="code" href="icaltime_8h.html#a78f4440633835d80c182488b11df9372">icaltime_today</a>();</div> -<div class="line">duration = <a class="code" href="icalduration_8h.html#a88157a8ae61263ea15af92a416889301">icaldurationtype_from_int</a>(60);</div> +<div class="line">time = <a class="code hl_function" href="icaltime_8h.html#a78f4440633835d80c182488b11df9372">icaltime_today</a>();</div> +<div class="line">duration = <a class="code hl_function" href="icalduration_8h.html#a88157a8ae61263ea15af92a416889301">icaldurationtype_from_int</a>(60);</div> <div class="line"> </div> <div class="line"><span class="comment">// add the duration to the time object</span></div> -<div class="line">time = <a class="code" href="icalduration_8h.html#aacc4e7db2c4b8dd96fd428edee73acf5">icaltime_add</a>(time, duration);</div> +<div class="line">time = <a class="code hl_function" href="icalduration_8h.html#aacc4e7db2c4b8dd96fd428edee73acf5">icaltime_add</a>(time, duration);</div> <div class="ttc" id="aicalduration_8h_html_aacc4e7db2c4b8dd96fd428edee73acf5"><div class="ttname"><a href="icalduration_8h.html#aacc4e7db2c4b8dd96fd428edee73acf5">icaltime_add</a></div><div class="ttdeci">struct icaltimetype icaltime_add(struct icaltimetype t, struct icaldurationtype d)</div><div class="ttdoc">Adds a duration to an ::icaltime object and returns the result.</div><div class="ttdef"><b>Definition:</b> icalduration.c:318</div></div> <div class="ttc" id="aicaltime_8h_html_a78f4440633835d80c182488b11df9372"><div class="ttname"><a href="icaltime_8h.html#a78f4440633835d80c182488b11df9372">icaltime_today</a></div><div class="ttdeci">struct icaltimetype icaltime_today(void)</div><div class="ttdoc">Convenience constructor.</div><div class="ttdef"><b>Definition:</b> icaltime.c:226</div></div> <div class="ttc" id="astructicaltimetype_html"><div class="ttname"><a href="structicaltimetype.html">icaltimetype</a></div><div class="ttdef"><b>Definition:</b> icaltime.h:105</div></div> </div><!-- fragment --> </div> </div> -<a id="aaafcb16e5d2aaa6eb0e20fdac419fc0d"></a> +<a id="aaafcb16e5d2aaa6eb0e20fdac419fc0d" name="aaafcb16e5d2aaa6eb0e20fdac419fc0d"></a> <h2 class="memtitle"><span class="permalink"><a href="#aaafcb16e5d2aaa6eb0e20fdac419fc0d">◆ </a></span>icaltime_subtract()</h2> <div class="memitem"> @@ -542,21 +540,21 @@ Example</h3> <dl class="section return"><dt>Returns</dt><dd>An <a class="el" href="structicaldurationtype.html" title="A struct representing a duration.">icaldurationtype</a> representing the duration the elapsed between <em>t1</em> and <em>t2</em> </dd></dl> <h3><a class="anchor" id="autotoc_md19"></a> Usage</h3> -<div class="fragment"><div class="line"><span class="keyword">struct </span><a class="code" href="structicaltimetype.html">icaltimetype</a> t1 = <a class="code" href="icaltime_8h.html#a2915233b392cc2a68aa5a9acf39e2307">icaltime_from_day_of_year</a>(111, 2018);</div> -<div class="line"><span class="keyword">struct </span><a class="code" href="structicaltimetype.html">icaltimetype</a> t2 = <a class="code" href="icaltime_8h.html#a2915233b392cc2a68aa5a9acf39e2307">icaltime_from_day_of_year</a>(112, 2018);</div> -<div class="line"><span class="keyword">struct </span><a class="code" href="structicaldurationtype.html">icaldurationtype</a> duration;</div> +<div class="fragment"><div class="line"><span class="keyword">struct </span><a class="code hl_struct" href="structicaltimetype.html">icaltimetype</a> t1 = <a class="code hl_function" href="icaltime_8h.html#a2915233b392cc2a68aa5a9acf39e2307">icaltime_from_day_of_year</a>(111, 2018);</div> +<div class="line"><span class="keyword">struct </span><a class="code hl_struct" href="structicaltimetype.html">icaltimetype</a> t2 = <a class="code hl_function" href="icaltime_8h.html#a2915233b392cc2a68aa5a9acf39e2307">icaltime_from_day_of_year</a>(112, 2018);</div> +<div class="line"><span class="keyword">struct </span><a class="code hl_struct" href="structicaldurationtype.html">icaldurationtype</a> duration;</div> <div class="line"> </div> <div class="line"><span class="comment">// calculate duration between time points</span></div> -<div class="line">duration = <a class="code" href="icalduration_8h.html#aaafcb16e5d2aaa6eb0e20fdac419fc0d">icaltime_subtract</a>(t1, t2);</div> +<div class="line">duration = <a class="code hl_function" href="icalduration_8h.html#aaafcb16e5d2aaa6eb0e20fdac419fc0d">icaltime_subtract</a>(t1, t2);</div> <div class="ttc" id="aicalduration_8h_html_aaafcb16e5d2aaa6eb0e20fdac419fc0d"><div class="ttname"><a href="icalduration_8h.html#aaafcb16e5d2aaa6eb0e20fdac419fc0d">icaltime_subtract</a></div><div class="ttdeci">struct icaldurationtype icaltime_subtract(struct icaltimetype t1, struct icaltimetype t2)</div><div class="ttdoc">Returns the difference between two icaltimetype as a duration.</div><div class="ttdef"><b>Definition:</b> icalduration.c:339</div></div> -<div class="ttc" id="aicaltime_8h_html_a2915233b392cc2a68aa5a9acf39e2307"><div class="ttname"><a href="icaltime_8h.html#a2915233b392cc2a68aa5a9acf39e2307">icaltime_from_day_of_year</a></div><div class="ttdeci">struct icaltimetype icaltime_from_day_of_year(const int doy, const int year)</div><div class="ttdoc">Constructor.</div><div class="ttdef"><b>Definition:</b> icaltime.c:518</div></div> +<div class="ttc" id="aicaltime_8h_html_a2915233b392cc2a68aa5a9acf39e2307"><div class="ttname"><a href="icaltime_8h.html#a2915233b392cc2a68aa5a9acf39e2307">icaltime_from_day_of_year</a></div><div class="ttdeci">struct icaltimetype icaltime_from_day_of_year(const int doy, const int year)</div><div class="ttdoc">Constructor.</div><div class="ttdef"><b>Definition:</b> icaltime.c:529</div></div> </div><!-- fragment --> </div> </div> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> -Generated on Sat Apr 9 2022 08:46:36 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 +Generated on Thu Jun 9 2022 13:07:03 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 </small></address> </body> </html> |