diff options
Diffstat (limited to 'apidocs/icalduration_8h_source.html')
| -rw-r--r-- | apidocs/icalduration_8h_source.html | 157 |
1 files changed, 157 insertions, 0 deletions
diff --git a/apidocs/icalduration_8h_source.html b/apidocs/icalduration_8h_source.html new file mode 100644 index 00000000..36f4b269 --- /dev/null +++ b/apidocs/icalduration_8h_source.html @@ -0,0 +1,157 @@ +<!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.9.1"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>Libical API Documentation: icalduration.h Source File</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></script> +<link href="doxygen.css" rel="stylesheet" type="text/css" /> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<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.0</span> + </div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.9.1 --> +<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-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 */ +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +/* @license-end */</script> +<div id="main-nav"></div> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div id="nav-path" class="navpath"> + <ul> +<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_b7a0ea939f6e83384f3c571d31a84be9.html">libical</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="headertitle"> +<div class="title">icalduration.h</div> </div> +</div><!--header--> +<div class="contents"> +<a href="icalduration_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*======================================================================</span></div> +<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> FILE: icalduration.h</span></div> +<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> CREATOR: eric 26 Jan 2001</span></div> +<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"></span> </div> +<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> (C) COPYRIGHT 2000, Eric Busboom <eric@civicknowledge.com></span></div> +<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"></span> </div> +<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> This library is free software; you can redistribute it and/or modify</span></div> +<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> it under the terms of either:</span></div> +<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"></span> </div> +<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> The LGPL as published by the Free Software Foundation, version</span></div> +<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> 2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html</span></div> +<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"></span> </div> +<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> Or:</span></div> +<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"></span> </div> +<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> The Mozilla Public License Version 2.0. You may obtain a copy of</span></div> +<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> the License at https://www.mozilla.org/MPL/</span></div> +<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"></span> </div> +<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> The Original Code is eric. The Initial Developer of the Original</span></div> +<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> Code is Eric Busboom</span></div> +<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">======================================================================*/</span></div> +<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  </div> +<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#ifndef ICALDURATION_H</span></div> +<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#define ICALDURATION_H</span></div> +<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  </div> +<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include "libical_ical_export.h"</span></div> +<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include "<a class="code" href="icaltime_8h.html">icaltime.h</a>"</span></div> +<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  </div> +<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="structicaldurationtype.html"> 36</a></span> <span class="keyword">struct </span><a class="code" href="structicaldurationtype.html">icaldurationtype</a></div> +<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> {</div> +<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keywordtype">int</span> is_neg;</div> +<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> days;</div> +<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> weeks;</div> +<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> hours;</div> +<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> minutes;</div> +<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> seconds;</div> +<div class="line"><a name="l00044"></a><span class="lineno"> 44</span> };</div> +<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  </div> +<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor">#define ICALDURATIONTYPE_INITIALIZER { 0, 0, 0, 0, 0, 0 }</span></div> +<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  </div> +<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> LIBICAL_ICAL_EXPORT <span class="keyword">struct </span><a class="code" href="structicaldurationtype.html">icaldurationtype</a> <a class="code" href="icalduration_8h.html#a88157a8ae61263ea15af92a416889301">icaldurationtype_from_int</a>(int t);</div> +<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  </div> +<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> LIBICAL_ICAL_EXPORT <span class="keyword">struct </span><a class="code" href="structicaldurationtype.html">icaldurationtype</a> <a class="code" href="icalduration_8h.html#a0d6d8cc773e19242448eaffb1368fef4">icaldurationtype_from_string</a>(const char *dur);</div> +<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  </div> +<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> LIBICAL_ICAL_EXPORT <span class="keywordtype">int</span> <a class="code" href="icalduration_8h.html#a1828c484b9efb3cb1f08ec5eb58c7a18">icaldurationtype_as_int</a>(<span class="keyword">struct</span> <a class="code" href="structicaldurationtype.html">icaldurationtype</a> duration);</div> +<div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  </div> +<div class="line"><a name="l00127"></a><span class="lineno"> 127</span> LIBICAL_ICAL_EXPORT <span class="keywordtype">char</span> *<a class="code" href="icalduration_8h.html#a7ebae580ab5bab4e9ffe822ff1dee9c8">icaldurationtype_as_ical_string</a>(<span class="keyword">struct</span> <a class="code" href="structicaldurationtype.html">icaldurationtype</a> d);</div> +<div class="line"><a name="l00128"></a><span class="lineno"> 128</span>  </div> +<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> LIBICAL_ICAL_EXPORT <span class="keywordtype">char</span> *<a class="code" href="icalduration_8h.html#a758d27dc5433c570f5ea5995c5001e79">icaldurationtype_as_ical_string_r</a>(<span class="keyword">struct</span> <a class="code" href="structicaldurationtype.html">icaldurationtype</a> d);</div> +<div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  </div> +<div class="line"><a name="l00172"></a><span class="lineno"> 172</span> LIBICAL_ICAL_EXPORT <span class="keyword">struct </span><a class="code" href="structicaldurationtype.html">icaldurationtype</a> <a class="code" href="icalduration_8h.html#ad716774a6570e0be2eb11868deb86595">icaldurationtype_null_duration</a>(void);</div> +<div class="line"><a name="l00173"></a><span class="lineno"> 173</span>  </div> +<div class="line"><a name="l00189"></a><span class="lineno"> 189</span> LIBICAL_ICAL_EXPORT <span class="keyword">struct </span><a class="code" href="structicaldurationtype.html">icaldurationtype</a> <a class="code" href="icalduration_8h.html#a2578535a23fc5c6d4d61c09c880f03fd">icaldurationtype_bad_duration</a>(void);</div> +<div class="line"><a name="l00190"></a><span class="lineno"> 190</span>  </div> +<div class="line"><a name="l00207"></a><span class="lineno"> 207</span> LIBICAL_ICAL_EXPORT <span class="keywordtype">int</span> <a class="code" href="icalduration_8h.html#afcdeddc439488d8f586db0702593c270">icaldurationtype_is_null_duration</a>(<span class="keyword">struct</span> <a class="code" href="structicaldurationtype.html">icaldurationtype</a> d);</div> +<div class="line"><a name="l00208"></a><span class="lineno"> 208</span>  </div> +<div class="line"><a name="l00225"></a><span class="lineno"> 225</span> LIBICAL_ICAL_EXPORT <span class="keywordtype">int</span> <a class="code" href="icalduration_8h.html#a88c5b90b57f9e1f79c00a544746687d6">icaldurationtype_is_bad_duration</a>(<span class="keyword">struct</span> <a class="code" href="structicaldurationtype.html">icaldurationtype</a> d);</div> +<div class="line"><a name="l00226"></a><span class="lineno"> 226</span>  </div> +<div class="line"><a name="l00246"></a><span class="lineno"> 246</span> LIBICAL_ICAL_EXPORT <span class="keyword">struct </span><a class="code" href="structicaltimetype.html">icaltimetype</a> <a class="code" href="icalduration_8h.html#aacc4e7db2c4b8dd96fd428edee73acf5">icaltime_add</a>(struct <a class="code" href="structicaltimetype.html">icaltimetype</a> t,</div> +<div class="line"><a name="l00247"></a><span class="lineno"> 247</span>  struct <a class="code" href="structicaldurationtype.html">icaldurationtype</a> d);</div> +<div class="line"><a name="l00248"></a><span class="lineno"> 248</span>  </div> +<div class="line"><a name="l00266"></a><span class="lineno"> 266</span> LIBICAL_ICAL_EXPORT <span class="keyword">struct </span><a class="code" href="structicaldurationtype.html">icaldurationtype</a> <a class="code" href="icalduration_8h.html#aaafcb16e5d2aaa6eb0e20fdac419fc0d">icaltime_subtract</a>(struct <a class="code" href="structicaltimetype.html">icaltimetype</a> t1,</div> +<div class="line"><a name="l00267"></a><span class="lineno"> 267</span>  struct <a class="code" href="structicaltimetype.html">icaltimetype</a> t2);</div> +<div class="line"><a name="l00268"></a><span class="lineno"> 268</span>  </div> +<div class="line"><a name="l00269"></a><span class="lineno"> 269</span> <span class="preprocessor">#endif </span><span class="comment">/* !ICALDURATION_H */</span><span class="preprocessor"></span></div> +<div class="ttc" id="aicalduration_8h_html_a0d6d8cc773e19242448eaffb1368fef4"><div class="ttname"><a href="icalduration_8h.html#a0d6d8cc773e19242448eaffb1368fef4">icaldurationtype_from_string</a></div><div class="ttdeci">struct icaldurationtype icaldurationtype_from_string(const char *dur)</div><div class="ttdoc">Creates a new icaldurationtype from a duration given as a string.</div><div class="ttdef"><b>Definition:</b> icalduration.c:62</div></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 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_a758d27dc5433c570f5ea5995c5001e79"><div class="ttname"><a href="icalduration_8h.html#a758d27dc5433c570f5ea5995c5001e79">icaldurationtype_as_ical_string_r</a></div><div class="ttdeci">char * icaldurationtype_as_ical_string_r(struct icaldurationtype d)</div><div class="ttdef"><b>Definition:</b> icalduration.c:220</div></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="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="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 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="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="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 class="ttc" id="aicaltime_8h_html"><div class="ttname"><a href="icaltime_8h.html">icaltime.h</a></div><div class="ttdoc">struct icaltimetype is a pseudo-object that abstracts time handling.</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 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><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated on Thu Oct 6 2022 11:56:07 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> |