diff options
Diffstat (limited to 'apidocs/icalperiod_8h.html')
| -rw-r--r-- | apidocs/icalperiod_8h.html | 359 |
1 files changed, 0 insertions, 359 deletions
diff --git a/apidocs/icalperiod_8h.html b/apidocs/icalperiod_8h.html deleted file mode 100644 index eb8d4ad9..00000000 --- a/apidocs/icalperiod_8h.html +++ /dev/null @@ -1,359 +0,0 @@ -<!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: icalperiod.h File Reference</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="summary"> -<a href="#nested-classes">Data Structures</a> | -<a href="#define-members">Macros</a> | -<a href="#func-members">Functions</a> </div> - <div class="headertitle"> -<div class="title">icalperiod.h File Reference</div> </div> -</div><!--header--> -<div class="contents"> - -<p>Functions for working with iCal periods (of time). -<a href="#details">More...</a></p> - -<p><a href="icalperiod_8h_source.html">Go to the source code of this file.</a></p> -<table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> -Data Structures</h2></td></tr> -<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structicalperiodtype.html">icalperiodtype</a></td></tr> -<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Struct to represent a period in time. <a href="structicalperiodtype.html#details">More...</a><br /></td></tr> -<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> -</table><table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> -Macros</h2></td></tr> -<tr class="memitem:ac369ae6f4dd1b5a6e0f9b2f4cf6e2e34"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><b>ICALPERIODTYPE_INITIALIZER</b></td></tr> -<tr class="separator:ac369ae6f4dd1b5a6e0f9b2f4cf6e2e34"><td class="memSeparator" colspan="2"> </td></tr> -</table><table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> -Functions</h2></td></tr> -<tr class="memitem:ac84e7fc00fa25286c1f109eb35a10883"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalperiod_8h.html#ac84e7fc00fa25286c1f109eb35a10883">icalperiodtype_as_ical_string</a> (struct <a class="el" href="structicalperiodtype.html">icalperiodtype</a> p)</td></tr> -<tr class="memdesc:ac84e7fc00fa25286c1f109eb35a10883"><td class="mdescLeft"> </td><td class="mdescRight">Converts an <a class="el" href="structicalperiodtype.html" title="Struct to represent a period in time.">icalperiodtype</a> into an iCal-formatted string. <a href="icalperiod_8h.html#ac84e7fc00fa25286c1f109eb35a10883">More...</a><br /></td></tr> -<tr class="separator:ac84e7fc00fa25286c1f109eb35a10883"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ac71be7790d778145a59ad9626458ccd5"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalperiod_8h.html#ac71be7790d778145a59ad9626458ccd5">icalperiodtype_as_ical_string_r</a> (struct <a class="el" href="structicalperiodtype.html">icalperiodtype</a> p)</td></tr> -<tr class="memdesc:ac71be7790d778145a59ad9626458ccd5"><td class="mdescLeft"> </td><td class="mdescRight">Converts an <a class="el" href="structicalperiodtype.html" title="Struct to represent a period in time.">icalperiodtype</a> into an iCal-formatted string. <a href="icalperiod_8h.html#ac71be7790d778145a59ad9626458ccd5">More...</a><br /></td></tr> -<tr class="separator:ac71be7790d778145a59ad9626458ccd5"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a827e35abf4d6349e15aeaa9a483064fd"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structicalperiodtype.html">icalperiodtype</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="icalperiod_8h.html#a827e35abf4d6349e15aeaa9a483064fd">icalperiodtype_from_string</a> (const char *str)</td></tr> -<tr class="memdesc:a827e35abf4d6349e15aeaa9a483064fd"><td class="mdescLeft"> </td><td class="mdescRight">Constructs a new <a class="el" href="structicalperiodtype.html" title="Struct to represent a period in time.">icalperiodtype</a> from <em>str</em>. <a href="icalperiod_8h.html#a827e35abf4d6349e15aeaa9a483064fd">More...</a><br /></td></tr> -<tr class="separator:a827e35abf4d6349e15aeaa9a483064fd"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ae184bb1351602b7763044c5167a96bdf"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="icalperiod_8h.html#ae184bb1351602b7763044c5167a96bdf">icalperiodtype_is_null_period</a> (struct <a class="el" href="structicalperiodtype.html">icalperiodtype</a> p)</td></tr> -<tr class="separator:ae184bb1351602b7763044c5167a96bdf"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:af7feaf12370cd37d66d160c4d8fbf0c7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="icalperiod_8h.html#af7feaf12370cd37d66d160c4d8fbf0c7">icalperiodtype_is_valid_period</a> (struct <a class="el" href="structicalperiodtype.html">icalperiodtype</a> p)</td></tr> -<tr class="separator:af7feaf12370cd37d66d160c4d8fbf0c7"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a60e59a9f46a1efa9885829a4d23eddfa"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structicalperiodtype.html">icalperiodtype</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="icalperiod_8h.html#a60e59a9f46a1efa9885829a4d23eddfa">icalperiodtype_null_period</a> (void)</td></tr> -<tr class="separator:a60e59a9f46a1efa9885829a4d23eddfa"><td class="memSeparator" colspan="2"> </td></tr> -</table> -<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> -<div class="textblock"><p>Functions for working with iCal periods (of time). </p> -</div><h2 class="groupheader">Macro Definition Documentation</h2> -<a id="ac369ae6f4dd1b5a6e0f9b2f4cf6e2e34"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ac369ae6f4dd1b5a6e0f9b2f4cf6e2e34">◆ </a></span>ICALPERIODTYPE_INITIALIZER</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">#define ICALPERIODTYPE_INITIALIZER</td> - </tr> - </table> -</div><div class="memdoc"> -<b>Value:</b><div class="fragment"><div class="line"> { \</div> -<div class="line"> ICALTIMETYPE_INITIALIZER, \</div> -<div class="line"> ICALTIMETYPE_INITIALIZER, \</div> -<div class="line"> ICALDURATIONTYPE_INITIALIZER \</div> -<div class="line">}</div> -</div><!-- fragment --> -</div> -</div> -<h2 class="groupheader">Function Documentation</h2> -<a id="ac84e7fc00fa25286c1f109eb35a10883"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ac84e7fc00fa25286c1f109eb35a10883">◆ </a></span>icalperiodtype_as_ical_string()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">const char* icalperiodtype_as_ical_string </td> - <td>(</td> - <td class="paramtype">struct <a class="el" href="structicalperiodtype.html">icalperiodtype</a> </td> - <td class="paramname"><em>p</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Converts an <a class="el" href="structicalperiodtype.html" title="Struct to represent a period in time.">icalperiodtype</a> into an iCal-formatted string. </p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">p</td><td>The time period to convert </td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>A string representing the iCal-formatted period </dd></dl> -<dl class="section see"><dt>See also</dt><dd><a class="el" href="icalperiod_8h.html#ac71be7790d778145a59ad9626458ccd5" title="Converts an icalperiodtype into an iCal-formatted string.">icalperiodtype_as_ical_string_r()</a></dd></dl> -<dl class="section user"><dt>Error handling</dt><dd>Sets <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value.">icalerrno</a> to <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833a3ed4d866c28acaaaf99348b1ab27cd78">ICAL_ALLOCATION_ERROR</a> if there was an internal error allocating memory.</dd></dl> -<dl class="section user"><dt>Ownership</dt><dd>The string returned by this method is owned by libical and must not be <code>free()</code> by the caller.</dd></dl> -<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"><span class="comment">// create icalperiodtype</span></div> -<div class="line"><span class="keyword">const</span> <span class="keywordtype">char</span> *period_string = <span class="stringliteral">"20170606T090000/20170607T090000"</span>;</div> -<div class="line"><span class="keyword">struct </span><a class="code" href="structicalperiodtype.html">icalperiodtype</a> period = <a class="code" href="icalperiod_8h.html#a827e35abf4d6349e15aeaa9a483064fd">icalperiodtype_from_string</a>(period_string);</div> -<div class="line"> </div> -<div class="line"><span class="comment">// print period in iCal format</span></div> -<div class="line">printf(<span class="stringliteral">"%s\n"</span>, <a class="code" href="icalperiod_8h.html#ac84e7fc00fa25286c1f109eb35a10883">icalperiodtype_as_ical_string</a>(period));</div> -<div class="ttc" id="aicalperiod_8h_html_a827e35abf4d6349e15aeaa9a483064fd"><div class="ttname"><a href="icalperiod_8h.html#a827e35abf4d6349e15aeaa9a483064fd">icalperiodtype_from_string</a></div><div class="ttdeci">struct icalperiodtype icalperiodtype_from_string(const char *str)</div><div class="ttdoc">Constructs a new icalperiodtype from str.</div><div class="ttdef"><b>Definition:</b> icalperiod.c:30</div></div> -<div class="ttc" id="aicalperiod_8h_html_ac84e7fc00fa25286c1f109eb35a10883"><div class="ttname"><a href="icalperiod_8h.html#ac84e7fc00fa25286c1f109eb35a10883">icalperiodtype_as_ical_string</a></div><div class="ttdeci">const char * icalperiodtype_as_ical_string(struct icalperiodtype p)</div><div class="ttdoc">Converts an icalperiodtype into an iCal-formatted string.</div><div class="ttdef"><b>Definition:</b> icalperiod.c:94</div></div> -<div class="ttc" id="astructicalperiodtype_html"><div class="ttname"><a href="structicalperiodtype.html">icalperiodtype</a></div><div class="ttdoc">Struct to represent a period in time.</div><div class="ttdef"><b>Definition:</b> icalperiod.h:38</div></div> -</div><!-- fragment --> </dd></dl> - -</div> -</div> -<a id="ac71be7790d778145a59ad9626458ccd5"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ac71be7790d778145a59ad9626458ccd5">◆ </a></span>icalperiodtype_as_ical_string_r()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">char* icalperiodtype_as_ical_string_r </td> - <td>(</td> - <td class="paramtype">struct <a class="el" href="structicalperiodtype.html">icalperiodtype</a> </td> - <td class="paramname"><em>p</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Converts an <a class="el" href="structicalperiodtype.html" title="Struct to represent a period in time.">icalperiodtype</a> into an iCal-formatted string. </p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">p</td><td>The time period to convert </td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>A string representing the iCal-formatted period </dd></dl> -<dl class="section see"><dt>See also</dt><dd><a class="el" href="icalperiod_8h.html#ac84e7fc00fa25286c1f109eb35a10883" title="Converts an icalperiodtype into an iCal-formatted string.">icalperiodtype_as_ical_string()</a></dd></dl> -<dl class="section user"><dt>Error handling</dt><dd>Sets <a class="el" href="icalerror_8h.html#ad2562706150f5c5a4d9b0ca149d78e37" title="Access the current icalerrno value.">icalerrno</a> to <a class="el" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833a3ed4d866c28acaaaf99348b1ab27cd78">ICAL_ALLOCATION_ERROR</a> if there was an internal error allocating memory.</dd></dl> -<dl class="section user"><dt>Ownership</dt><dd>The string returned by this method is owned by the caller and must be released with the appropriate function after use.</dd></dl> -<dl class="section user"><dt>Example</dt><dd><div class="fragment"><div class="line"><span class="comment">// create icalperiodtype</span></div> -<div class="line"><span class="keyword">const</span> <span class="keywordtype">char</span> *period_string = <span class="stringliteral">"20170606T090000/20170607T090000"</span>;</div> -<div class="line"><span class="keyword">struct </span><a class="code" href="structicalperiodtype.html">icalperiodtype</a> period = <a class="code" href="icalperiod_8h.html#a827e35abf4d6349e15aeaa9a483064fd">icalperiodtype_from_string</a>(period_string);</div> -<div class="line"> </div> -<div class="line"><span class="comment">// print period in iCal format</span></div> -<div class="line"><span class="keyword">const</span> <span class="keywordtype">char</span> *period_string_gen = <a class="code" href="icalperiod_8h.html#ac71be7790d778145a59ad9626458ccd5">icalperiodtype_as_ical_string_r</a>(period);</div> -<div class="line">printf(<span class="stringliteral">"%s\n"</span>, period_string_gen);</div> -<div class="line"><a class="code" href="icalmemory_8h.html#a2f164cb87c67f06b5dc04a5f21384879">icalmemory_free_buffer</a>(period_string_gen);</div> -<div class="ttc" id="aicalmemory_8h_html_a2f164cb87c67f06b5dc04a5f21384879"><div class="ttname"><a href="icalmemory_8h.html#a2f164cb87c67f06b5dc04a5f21384879">icalmemory_free_buffer</a></div><div class="ttdeci">void icalmemory_free_buffer(void *buf)</div><div class="ttdoc">Releases a buffer.</div><div class="ttdef"><b>Definition:</b> icalmemory.c:287</div></div> -<div class="ttc" id="aicalperiod_8h_html_ac71be7790d778145a59ad9626458ccd5"><div class="ttname"><a href="icalperiod_8h.html#ac71be7790d778145a59ad9626458ccd5">icalperiodtype_as_ical_string_r</a></div><div class="ttdeci">char * icalperiodtype_as_ical_string_r(struct icalperiodtype p)</div><div class="ttdoc">Converts an icalperiodtype into an iCal-formatted string.</div><div class="ttdef"><b>Definition:</b> icalperiod.c:103</div></div> -</div><!-- fragment --> </dd></dl> - -</div> -</div> -<a id="a827e35abf4d6349e15aeaa9a483064fd"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a827e35abf4d6349e15aeaa9a483064fd">◆ </a></span>icalperiodtype_from_string()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">struct <a class="el" href="structicalperiodtype.html">icalperiodtype</a> icalperiodtype_from_string </td> - <td>(</td> - <td class="paramtype">const char * </td> - <td class="paramname"><em>str</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> - -<p>Constructs a new <a class="el" href="structicalperiodtype.html" title="Struct to represent a period in time.">icalperiodtype</a> from <em>str</em>. </p> -<dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">str</td><td>The string from which to construct a time period </td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>An <a class="el" href="structicalperiodtype.html" title="Struct to represent a period in time.">icalperiodtype</a> representing the period <em>str</em> </dd></dl> -<dl class="section see"><dt>See also</dt><dd><a class="el" href="icaltime_8h.html#a1b66b9f52a9823b95e4cd33f9dd9b8e5" title="Constructor.">icaltime_from_string()</a>, <a class="el" href="icalduration_8h.html#a0d6d8cc773e19242448eaffb1368fef4" title="Creates a new icaldurationtype from a duration given as a string.">icaldurationtype_from_string()</a></dd></dl> -<dl class="section user"><dt>Error handling</dt><dd>If <em>str</em> is not properly formatted, 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 returns <a class="el" href="icalperiod_8h.html#a60e59a9f46a1efa9885829a4d23eddfa">icalperiodtype_null_period()</a>.</dd></dl> -<dl class="section user"><dt>Data format</dt><dd>There are two ways to specify a duration; either a start time and an end time can be specified, or a start time and a duration. The format for there is as such:<ul> -<li><code><STARTTIME>/<ENDTIME></code></li> -<li><code><STARTTIME>/<DURATION></code></li> -</ul> -</dd></dl> -<p>The format for the times is the same as those used by <a class="el" href="icaltime_8h.html#a1b66b9f52a9823b95e4cd33f9dd9b8e5" title="Constructor.">icaltime_from_string()</a>, and the format for the duration is the same as that used by <a class="el" href="icalduration_8h.html#a0d6d8cc773e19242448eaffb1368fef4" title="Creates a new icaldurationtype from a duration given as a string.">icaldurationtype_from_string()</a>.</p> -<dl class="section user"><dt>Usage</dt><dd><div class="fragment"><div class="line"><span class="comment">// create icalperiodtype</span></div> -<div class="line"><span class="keyword">const</span> <span class="keywordtype">char</span> *period_string = <span class="stringliteral">"20170606T090000/20170607T090000"</span>;</div> -<div class="line"><span class="keyword">struct </span><a class="code" href="structicalperiodtype.html">icalperiodtype</a> period = <a class="code" href="icalperiod_8h.html#a827e35abf4d6349e15aeaa9a483064fd">icalperiodtype_from_string</a>(period_string);</div> -<div class="line"> </div> -<div class="line"><span class="comment">// print period in iCal format</span></div> -<div class="line">printf(<span class="stringliteral">"%s\n"</span>, <a class="code" href="icalperiod_8h.html#ac84e7fc00fa25286c1f109eb35a10883">icalperiodtype_as_ical_string</a>(period));</div> -</div><!-- fragment --> </dd></dl> - -</div> -</div> -<a id="ae184bb1351602b7763044c5167a96bdf"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ae184bb1351602b7763044c5167a96bdf">◆ </a></span>icalperiodtype_is_null_period()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">int icalperiodtype_is_null_period </td> - <td>(</td> - <td class="paramtype">struct <a class="el" href="structicalperiodtype.html">icalperiodtype</a> </td> - <td class="paramname"><em>p</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Checks if a given <a class="el" href="structicalperiodtype.html" title="Struct to represent a period in time.">icalperiodtype</a> is a null period. </p><dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">p</td><td>The time period to check </td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>1 if <em>p</em> is a null period, 0 otherwise </dd></dl> -<dl class="section see"><dt>See also</dt><dd><a class="el" href="icalperiod_8h.html#a60e59a9f46a1efa9885829a4d23eddfa">icalperiodtype_null_period()</a></dd></dl> -<dl class="section user"><dt>Usage</dt><dd><div class="fragment"><div class="line"><span class="comment">// creates null period</span></div> -<div class="line"><span class="keyword">struct </span><a class="code" href="structicalperiodtype.html">icalperiodtype</a> period = <a class="code" href="icalperiod_8h.html#a60e59a9f46a1efa9885829a4d23eddfa">icalperiodtype_null_period</a>();</div> -<div class="line"> </div> -<div class="line"><span class="comment">// checks if it's a null period</span></div> -<div class="line">assert(<a class="code" href="icalperiod_8h.html#ae184bb1351602b7763044c5167a96bdf">icalperiodtype_is_null_period</a>(period));</div> -<div class="ttc" id="aicalperiod_8h_html_a60e59a9f46a1efa9885829a4d23eddfa"><div class="ttname"><a href="icalperiod_8h.html#a60e59a9f46a1efa9885829a4d23eddfa">icalperiodtype_null_period</a></div><div class="ttdeci">struct icalperiodtype icalperiodtype_null_period(void)</div><div class="ttdef"><b>Definition:</b> icalperiod.c:133</div></div> -<div class="ttc" id="aicalperiod_8h_html_ae184bb1351602b7763044c5167a96bdf"><div class="ttname"><a href="icalperiod_8h.html#ae184bb1351602b7763044c5167a96bdf">icalperiodtype_is_null_period</a></div><div class="ttdeci">int icalperiodtype_is_null_period(struct icalperiodtype p)</div><div class="ttdef"><b>Definition:</b> icalperiod.c:144</div></div> -</div><!-- fragment --> </dd></dl> - -</div> -</div> -<a id="af7feaf12370cd37d66d160c4d8fbf0c7"></a> -<h2 class="memtitle"><span class="permalink"><a href="#af7feaf12370cd37d66d160c4d8fbf0c7">◆ </a></span>icalperiodtype_is_valid_period()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">int icalperiodtype_is_valid_period </td> - <td>(</td> - <td class="paramtype">struct <a class="el" href="structicalperiodtype.html">icalperiodtype</a> </td> - <td class="paramname"><em>p</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Checks if a given <a class="el" href="structicalperiodtype.html" title="Struct to represent a period in time.">icalperiodtype</a> is a valid period. </p><dl class="params"><dt>Parameters</dt><dd> - <table class="params"> - <tr><td class="paramname">p</td><td>The time period to check </td></tr> - </table> - </dd> -</dl> -<dl class="section return"><dt>Returns</dt><dd>1 if <em>p</em> is a valid period, 0 otherwise</dd></dl> -<dl class="section user"><dt>Usage</dt><dd><div class="fragment"><div class="line"><span class="comment">// creates null period</span></div> -<div class="line"><span class="keyword">struct </span><a class="code" href="structicalperiodtype.html">icalperiodtype</a> period = <a class="code" href="icalperiod_8h.html#a60e59a9f46a1efa9885829a4d23eddfa">icalperiodtype_null_period</a>();</div> -<div class="line"> </div> -<div class="line"><span class="comment">// a null period isn't a valid period</span></div> -<div class="line">assert(<a class="code" href="icalperiod_8h.html#af7feaf12370cd37d66d160c4d8fbf0c7">icalperiodtype_is_valid_period</a>(period) == 0);</div> -<div class="ttc" id="aicalperiod_8h_html_af7feaf12370cd37d66d160c4d8fbf0c7"><div class="ttname"><a href="icalperiod_8h.html#af7feaf12370cd37d66d160c4d8fbf0c7">icalperiodtype_is_valid_period</a></div><div class="ttdeci">int icalperiodtype_is_valid_period(struct icalperiodtype p)</div><div class="ttdef"><b>Definition:</b> icalperiod.c:154</div></div> -</div><!-- fragment --> </dd></dl> - -</div> -</div> -<a id="a60e59a9f46a1efa9885829a4d23eddfa"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a60e59a9f46a1efa9885829a4d23eddfa">◆ </a></span>icalperiodtype_null_period()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">struct <a class="el" href="structicalperiodtype.html">icalperiodtype</a> icalperiodtype_null_period </td> - <td>(</td> - <td class="paramtype">void </td> - <td class="paramname"></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Creates a null period <a class="el" href="structicalperiodtype.html" title="Struct to represent a period in time.">icalperiodtype</a>. </p><dl class="section return"><dt>Returns</dt><dd>An <a class="el" href="structicalperiodtype.html" title="Struct to represent a period in time.">icalperiodtype</a> representing a null period </dd></dl> -<dl class="section see"><dt>See also</dt><dd><a class="el" href="icalperiod_8h.html#ae184bb1351602b7763044c5167a96bdf">icalperiodtype_is_null_period()</a></dd></dl> -<dl class="section user"><dt>Usage</dt><dd><div class="fragment"><div class="line"><span class="comment">// creates null period</span></div> -<div class="line"><span class="keyword">struct </span><a class="code" href="structicalperiodtype.html">icalperiodtype</a> period = <a class="code" href="icalperiod_8h.html#a60e59a9f46a1efa9885829a4d23eddfa">icalperiodtype_null_period</a>();</div> -<div class="line"> </div> -<div class="line"><span class="comment">// verifies start, end and length</span></div> -<div class="line">assert(<a class="code" href="icaltime_8h.html#a97483d9daf2fc8f8b1bbdc0c75ced095">icaltime_is_null_time</a>(period.start));</div> -<div class="line">assert(<a class="code" href="icaltime_8h.html#a97483d9daf2fc8f8b1bbdc0c75ced095">icaltime_is_null_time</a>(period.end));</div> -<div class="line">assert(icaldurationtype_is_null_duratino(period.duration));</div> -<div class="ttc" id="aicaltime_8h_html_a97483d9daf2fc8f8b1bbdc0c75ced095"><div class="ttname"><a href="icaltime_8h.html#a97483d9daf2fc8f8b1bbdc0c75ced095">icaltime_is_null_time</a></div><div class="ttdeci">int icaltime_is_null_time(const struct icaltimetype t)</div><div class="ttdoc">Returns true if the time is null.</div><div class="ttdef"><b>Definition:</b> icaltime.c:617</div></div> -</div><!-- fragment --> </dd></dl> - -</div> -</div> -</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> |