diff options
Diffstat (limited to 'apidocs/icalduration_8h.html')
| -rw-r--r-- | apidocs/icalduration_8h.html | 37 |
1 files changed, 19 insertions, 18 deletions
diff --git a/apidocs/icalduration_8h.html b/apidocs/icalduration_8h.html index d29b6314..130493b7 100644 --- a/apidocs/icalduration_8h.html +++ b/apidocs/icalduration_8h.html @@ -21,7 +21,7 @@ <tbody> <tr id="projectrow"> <td id="projectalign"> - <div id="projectname">Libical API Documentation<span id="projectnumber"> 3.0</span> + <div id="projectname">Libical API Documentation<span id="projectnumber"> 3.1</span> </div> </td> </tr> @@ -151,7 +151,7 @@ Functions</h2></td></tr> </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#ab87c9958f888dba23afa2249110ca137">icaldurationtype_as_ical_string_r()</a></dd></dl> -<dl class="section user"><dt>Ownership</dt><dd>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.</dd></dl> +<dl class="section user"><dt>Ownership</dt><dd>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.</dd></dl> <dl class="section user"><dt>Usage</dt><dd><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> @@ -161,10 +161,11 @@ Functions</h2></td></tr> <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">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="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 class="line"><a class="code hl_function" href="icalmemory_8h.html#a2f164cb87c67f06b5dc04a5f21384879">icalmemory_free_buffer</a>(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:23</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:202</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:359</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> ical.h:492</div></div> </div><!-- fragment --> </dd></dl> </div> @@ -233,7 +234,7 @@ Functions</h2></td></tr> <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 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 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:260</div></div> </div><!-- fragment --> </dd></dl> </div> @@ -263,8 +264,8 @@ Functions</h2></td></tr> <div class="line"> </div> <div class="line"><span class="comment">// make sure it's bad</span></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 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:295</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:304</div></div> </div><!-- fragment --> </dd></dl> </div> @@ -334,7 +335,7 @@ Functions</h2></td></tr> <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 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_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:53</div></div> </div><!-- fragment --> </dd></dl> </div> @@ -405,8 +406,8 @@ Functions</h2></td></tr> <div class="line"> </div> <div class="line"><span class="comment">// check null duration</span></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 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:270</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:279</div></div> </div><!-- fragment --> </dd></dl> </div> @@ -490,9 +491,9 @@ Functions</h2></td></tr> <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 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 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:309</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:217</div></div> +<div class="ttc" id="astructicaltimetype_html"><div class="ttname"><a href="structicaltimetype.html">icaltimetype</a></div><div class="ttdef"><b>Definition:</b> ical.h:141</div></div> </div><!-- fragment --> </dd></dl> </div> @@ -538,8 +539,8 @@ Functions</h2></td></tr> <div class="line"> </div> <div class="line"><span class="comment">// calculate duration between time points</span></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:529</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:330</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:511</div></div> </div><!-- fragment --> </dd></dl> </div> @@ -547,7 +548,7 @@ Functions</h2></td></tr> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> -Generated on Fri Jun 10 2022 08:27:16 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 Sat Jun 18 2022 10:19:40 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> |