diff options
Diffstat (limited to 'apidocs/icalduration_8h.html')
| -rw-r--r-- | apidocs/icalduration_8h.html | 61 |
1 files changed, 26 insertions, 35 deletions
diff --git a/apidocs/icalduration_8h.html b/apidocs/icalduration_8h.html index 61cb1161..01db8d06 100644 --- a/apidocs/icalduration_8h.html +++ b/apidocs/icalduration_8h.html @@ -1,9 +1,9 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> -<meta name="generator" content="Doxygen 1.8.14"/> +<meta name="generator" content="Doxygen 1.8.15"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>Libical API Documentation: icalduration.h File Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> @@ -30,7 +30,7 @@ </table> </div> <!-- end header part --> -<!-- Generated by Doxygen 1.8.14 --> +<!-- Generated by Doxygen 1.8.15 --> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ var searchBox = new SearchBox("searchBox", "search",false,'Search'); @@ -92,16 +92,16 @@ Functions</h2></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: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="#a1828c484b9efb3cb1f08ec5eb58c7a18">More...</a><br /></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="#a1828c484b9efb3cb1f08ec5eb58c7a18">More...</a><br /></td></tr> <tr class="separator:a1828c484b9efb3cb1f08ec5eb58c7a18"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2578535a23fc5c6d4d61c09c880f03fd"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structicaldurationtype.html">icaldurationtype</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="icalduration_8h.html#a2578535a23fc5c6d4d61c09c880f03fd">icaldurationtype_bad_duration</a> (void)</td></tr> <tr class="memdesc:a2578535a23fc5c6d4d61c09c880f03fd"><td class="mdescLeft"> </td><td class="mdescRight">Creates a bad duration (used to indicate error). <a href="#a2578535a23fc5c6d4d61c09c880f03fd">More...</a><br /></td></tr> <tr class="separator:a2578535a23fc5c6d4d61c09c880f03fd"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a88157a8ae61263ea15af92a416889301"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structicaldurationtype.html">icaldurationtype</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="icalduration_8h.html#a88157a8ae61263ea15af92a416889301">icaldurationtype_from_int</a> (int t)</td></tr> -<tr class="memdesc:a88157a8ae61263ea15af92a416889301"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new <a class="el" href="structicaldurationtype.html" title="A struct representing a duration. ">icaldurationtype</a> from a duration in seconds. <a href="#a88157a8ae61263ea15af92a416889301">More...</a><br /></td></tr> +<tr class="memdesc:a88157a8ae61263ea15af92a416889301"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new <a class="el" href="structicaldurationtype.html" title="A struct representing a duration.">icaldurationtype</a> from a duration in seconds. <a href="#a88157a8ae61263ea15af92a416889301">More...</a><br /></td></tr> <tr class="separator:a88157a8ae61263ea15af92a416889301"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a0d6d8cc773e19242448eaffb1368fef4"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structicaldurationtype.html">icaldurationtype</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="icalduration_8h.html#a0d6d8cc773e19242448eaffb1368fef4">icaldurationtype_from_string</a> (const char *dur)</td></tr> -<tr class="memdesc:a0d6d8cc773e19242448eaffb1368fef4"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new <a class="el" href="structicaldurationtype.html" title="A struct representing a duration. ">icaldurationtype</a> from a duration given as a string. <a href="#a0d6d8cc773e19242448eaffb1368fef4">More...</a><br /></td></tr> +<tr class="memdesc:a0d6d8cc773e19242448eaffb1368fef4"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new <a class="el" href="structicaldurationtype.html" title="A struct representing a duration.">icaldurationtype</a> from a duration given as a string. <a href="#a0d6d8cc773e19242448eaffb1368fef4">More...</a><br /></td></tr> <tr class="separator:a0d6d8cc773e19242448eaffb1368fef4"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a88c5b90b57f9e1f79c00a544746687d6"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="icalduration_8h.html#a88c5b90b57f9e1f79c00a544746687d6">icaldurationtype_is_bad_duration</a> (struct <a class="el" href="structicaldurationtype.html">icaldurationtype</a> d)</td></tr> <tr class="memdesc:a88c5b90b57f9e1f79c00a544746687d6"><td class="mdescLeft"> </td><td class="mdescRight">Checks if a duration is a bad duration. <a href="#a88c5b90b57f9e1f79c00a544746687d6">More...</a><br /></td></tr> @@ -192,7 +192,7 @@ Functions</h2></td></tr> </table> </div><div class="memdoc"> -<p>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>. </p> +<p>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>. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">duration</td><td>The duration to convert to seconds </td></tr> @@ -200,8 +200,7 @@ Functions</h2></td></tr> </dd> </dl> <dl class="section return"><dt>Returns</dt><dd>An <code>int</code> representing the duration in seconds</dd></dl> -<h3>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"></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><!-- fragment --> +<p>### Usage </p><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"></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><!-- fragment --> </div> </div> <a id="a2578535a23fc5c6d4d61c09c880f03fd"></a> @@ -222,9 +221,8 @@ Functions</h2></td></tr> <p>Creates a bad duration (used to indicate error). </p> <dl class="section return"><dt>Returns</dt><dd>A bad duration </dd></dl> -<dl class="section see"><dt>See also</dt><dd><a class="el" href="icalduration_8h.html#a88c5b90b57f9e1f79c00a544746687d6" title="Checks if a duration is a bad duration. ">icaldurationtype_is_bad_duration()</a></dd></dl> -<h3>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"></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><!-- fragment --> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="icalduration_8h.html#a88c5b90b57f9e1f79c00a544746687d6" title="Checks if a duration is a bad duration.">icaldurationtype_is_bad_duration()</a></dd></dl> +<p>### Usage </p><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"></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><!-- fragment --> </div> </div> <a id="a88157a8ae61263ea15af92a416889301"></a> @@ -243,16 +241,15 @@ Functions</h2></td></tr> </table> </div><div class="memdoc"> -<p>Creates a new <a class="el" href="structicaldurationtype.html" title="A struct representing a duration. ">icaldurationtype</a> from a duration in seconds. </p> +<p>Creates a new <a class="el" href="structicaldurationtype.html" title="A struct representing a duration.">icaldurationtype</a> from a duration in seconds. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">t</td><td>The duration in seconds </td></tr> </table> </dd> </dl> -<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 <em>t</em> in seconds</dd></dl> -<h3>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"></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 --> +<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 <em>t</em> in seconds</dd></dl> +<p>### Example </p><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"></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> @@ -271,17 +268,16 @@ Functions</h2></td></tr> </table> </div><div class="memdoc"> -<p>Creates a new <a class="el" href="structicaldurationtype.html" title="A struct representing a duration. ">icaldurationtype</a> from a duration given as a string. </p> +<p>Creates a new <a class="el" href="structicaldurationtype.html" title="A struct representing a duration.">icaldurationtype</a> from a duration given as a string. </p> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">dur</td><td>The duration as a string </td></tr> </table> </dd> </dl> -<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 <em>dur</em> </dd></dl> -<dl class="section user"><dt>Error handling</dt><dd>When given bad input, 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> and returnes <a class="el" href="icalduration_8h.html#a2578535a23fc5c6d4d61c09c880f03fd" title="Creates a bad duration (used to indicate error). ">icaldurationtype_bad_duration()</a>.</dd></dl> -<h3>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"></div><div class="line"><span class="comment">// verify that it's 5 minutes</span></div><div class="line">assert(duration.minutes == 5);</div></div><!-- fragment --> +<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 <em>dur</em> </dd></dl> +<dl class="section user"><dt>Error handling</dt><dd>When given bad input, 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> and returnes <a class="el" href="icalduration_8h.html#a2578535a23fc5c6d4d61c09c880f03fd" title="Creates a bad duration (used to indicate error).">icaldurationtype_bad_duration()</a>.</dd></dl> +<p>### Usage </p><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"></div><div class="line"><span class="comment">// verify that it's 5 minutes</span></div><div class="line">assert(duration.minutes == 5);</div></div><!-- fragment --> </div> </div> <a id="a88c5b90b57f9e1f79c00a544746687d6"></a> @@ -309,8 +305,7 @@ Functions</h2></td></tr> </dl> <dl class="section return"><dt>Returns</dt><dd>1 if the duration is a bad duration, 0 otherwise </dd></dl> <dl class="section see"><dt>See also</dt><dd>icalduration_bad_duration()</dd></dl> -<h3>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"></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><!-- fragment --> +<p>### Usage </p><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"></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><!-- fragment --> </div> </div> <a id="afcdeddc439488d8f586db0702593c270"></a> @@ -338,8 +333,7 @@ Functions</h2></td></tr> </dl> <dl class="section return"><dt>Returns</dt><dd>1 if the duration is a null duration, 0 otherwise </dd></dl> <dl class="section see"><dt>See also</dt><dd>icalduration_null_duration()</dd></dl> -<h3>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"></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><!-- fragment --> +<p>### Usage </p><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"></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><!-- fragment --> </div> </div> <a id="ad716774a6570e0be2eb11868deb86595"></a> @@ -359,10 +353,9 @@ Functions</h2></td></tr> </div><div class="memdoc"> <p>Creates a duration with zero length. </p> -<dl class="section return"><dt>Returns</dt><dd>An <a class="el" href="structicaldurationtype.html" title="A struct representing a duration. ">icaldurationtype</a> with a zero length </dd></dl> -<dl class="section see"><dt>See also</dt><dd><a class="el" href="icalduration_8h.html#afcdeddc439488d8f586db0702593c270" title="Checks if a duration is a null duration. ">icaldurationtype_is_null_duration()</a></dd></dl> -<h3>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"></div><div class="line"><span class="comment">// make sure it's zero length</span></div><div class="line">assert(duration.days == 0);</div><div class="line">assert(duration.weeks == 0);</div><div class="line">assert(duration.hours == 0);</div><div class="line">assert(duration.minutes == 0);</div><div class="line">assert(duration.seconds == 0);</div><div class="line">assert(icalduration_is_null_duration(duration));</div><div class="line">assert(icalduration_as_int(duration) == 0);</div></div><!-- fragment --> +<dl class="section return"><dt>Returns</dt><dd>An <a class="el" href="structicaldurationtype.html" title="A struct representing a duration.">icaldurationtype</a> with a zero length </dd></dl> +<dl class="section see"><dt>See also</dt><dd><a class="el" href="icalduration_8h.html#afcdeddc439488d8f586db0702593c270" title="Checks if a duration is a null duration.">icaldurationtype_is_null_duration()</a></dd></dl> +<p>### Usage </p><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"></div><div class="line"><span class="comment">// make sure it's zero length</span></div><div class="line">assert(duration.days == 0);</div><div class="line">assert(duration.weeks == 0);</div><div class="line">assert(duration.hours == 0);</div><div class="line">assert(duration.minutes == 0);</div><div class="line">assert(duration.seconds == 0);</div><div class="line">assert(icalduration_is_null_duration(duration));</div><div class="line">assert(icalduration_as_int(duration) == 0);</div></div><!-- fragment --> </div> </div> <a id="aacc4e7db2c4b8dd96fd428edee73acf5"></a> @@ -400,8 +393,7 @@ Functions</h2></td></tr> </dd> </dl> <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>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="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"></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><!-- fragment --> +<p>### Example </p><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="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"></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><!-- fragment --> </div> </div> <a id="aaafcb16e5d2aaa6eb0e20fdac419fc0d"></a> @@ -438,9 +430,8 @@ Functions</h2></td></tr> </table> </dd> </dl> -<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>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="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><!-- fragment --> +<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> +<p>### Usage </p><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="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><!-- fragment --> </div> </div> </div><!-- contents --> @@ -448,7 +439,7 @@ Functions</h2></td></tr> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> -</a> 1.8.14 +</a> 1.8.15 </small></address> </body> </html> |