summaryrefslogtreecommitdiff
path: root/apidocs/icalperiod_8h.html
diff options
context:
space:
mode:
authorPatrick Elsen <pelsen@xfbs.net>2017-07-19 17:43:50 +0200
committerPatrick Elsen <pelsen@xfbs.net>2017-07-19 17:43:50 +0200
commit153fa696c18b95e508022e0cc6ce2326676135e5 (patch)
treee5cd99b7eb745bd03745b46d8b93d4fe56c0d32a /apidocs/icalperiod_8h.html
parent8432310a4aaf2ee139b63a2fa201a0441c138ac8 (diff)
downloadlibical-git-153fa696c18b95e508022e0cc6ce2326676135e5.tar.gz
updates apidocs
Diffstat (limited to 'apidocs/icalperiod_8h.html')
-rw-r--r--apidocs/icalperiod_8h.html274
1 files changed, 274 insertions, 0 deletions
diff --git a/apidocs/icalperiod_8h.html b/apidocs/icalperiod_8h.html
new file mode 100644
index 00000000..9518f26d
--- /dev/null
+++ b/apidocs/icalperiod_8h.html
@@ -0,0 +1,274 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
+<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
+ &#160;<span id="projectnumber">2.99</span>
+ </div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<!-- Generated by Doxygen 1.8.13 -->
+<script type="text/javascript">
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+</script>
+<script type="text/javascript" src="menudata.js"></script>
+<script type="text/javascript" src="menu.js"></script>
+<script type="text/javascript">
+$(function() {
+ initMenu('',true,false,'search.php','Search');
+ $(document).ready(function() { init_search(); });
+});
+</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> &#124;
+<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 &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structicalperiodtype.html">icalperiodtype</a></td></tr>
+<tr class="memdesc:"><td class="mdescLeft">&#160;</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">&#160;</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 *&#160;</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">&#160;</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="#ac84e7fc00fa25286c1f109eb35a10883">More...</a><br /></td></tr>
+<tr class="separator:ac84e7fc00fa25286c1f109eb35a10883"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ac71be7790d778145a59ad9626458ccd5"><td class="memItemLeft" align="right" valign="top">char *&#160;</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">&#160;</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="#ac71be7790d778145a59ad9626458ccd5">More...</a><br /></td></tr>
+<tr class="separator:ac71be7790d778145a59ad9626458ccd5"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:a827e35abf4d6349e15aeaa9a483064fd"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structicalperiodtype.html">icalperiodtype</a>&#160;</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">&#160;</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="#a827e35abf4d6349e15aeaa9a483064fd">More...</a><br /></td></tr>
+<tr class="separator:a827e35abf4d6349e15aeaa9a483064fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ae184bb1351602b7763044c5167a96bdf"><td class="memItemLeft" align="right" valign="top">int&#160;</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">&#160;</td></tr>
+<tr class="memitem:af7feaf12370cd37d66d160c4d8fbf0c7"><td class="memItemLeft" align="right" valign="top">int&#160;</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">&#160;</td></tr>
+<tr class="memitem:a60e59a9f46a1efa9885829a4d23eddfa"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structicalperiodtype.html">icalperiodtype</a>&#160;</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">&#160;</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">Function Documentation</h2>
+<a id="ac84e7fc00fa25286c1f109eb35a10883"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ac84e7fc00fa25286c1f109eb35a10883">&#9670;&nbsp;</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>&#160;</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>
+<h3>Example</h3>
+<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">&quot;20170606T090000/20170607T090000&quot;</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">&quot;%s\n&quot;</span>, <a class="code" href="icalperiod_8h.html#ac84e7fc00fa25286c1f109eb35a10883">icalperiodtype_as_ical_string</a>(period));</div></div><!-- fragment -->
+</div>
+</div>
+<a id="ac71be7790d778145a59ad9626458ccd5"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ac71be7790d778145a59ad9626458ccd5">&#9670;&nbsp;</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>&#160;</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>
+<h3>Example</h3>
+<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">&quot;20170606T090000/20170607T090000&quot;</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">&quot;%s\n&quot;</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><!-- fragment -->
+</div>
+</div>
+<a id="a827e35abf4d6349e15aeaa9a483064fd"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a827e35abf4d6349e15aeaa9a483064fd">&#9670;&nbsp;</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 *&#160;</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 peroid <em>str</em> </dd></dl>
+<dl class="section see"><dt>See also</dt><dd><a class="el" href="icaltime_8h.html#a1b66b9f52a9823b95e4cd33f9dd9b8e5" title="Contructor. ">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>
+<h3>Data format</h3>
+<p>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:</p><ul>
+<li><code>&lt;STARTTIME&gt;/&lt;ENDTIME&gt;</code></li>
+<li><code>&lt;STARTTIME&gt;/&lt;DURATION&gt;</code></li>
+</ul>
+<p>The format for the times is the same as those used by <a class="el" href="icaltime_8h.html#a1b66b9f52a9823b95e4cd33f9dd9b8e5" title="Contructor. ">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>
+<h3>Usage</h3>
+<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">&quot;20170606T090000/20170607T090000&quot;</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">&quot;%s\n&quot;</span>, <a class="code" href="icalperiod_8h.html#ac84e7fc00fa25286c1f109eb35a10883">icalperiodtype_as_ical_string</a>(period));</div></div><!-- fragment -->
+</div>
+</div>
+<a id="ae184bb1351602b7763044c5167a96bdf"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ae184bb1351602b7763044c5167a96bdf">&#9670;&nbsp;</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>&#160;</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="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>
+<h3>Usage</h3>
+<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&#39;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><!-- fragment -->
+</div>
+</div>
+<a id="af7feaf12370cd37d66d160c4d8fbf0c7"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#af7feaf12370cd37d66d160c4d8fbf0c7">&#9670;&nbsp;</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>&#160;</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="section return"><dt>Returns</dt><dd>1 if <em>p</em> is a valid period, 0 otherwise</dd></dl>
+<h3>Usage</h3>
+<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&#39;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><!-- fragment -->
+</div>
+</div>
+<a id="a60e59a9f46a1efa9885829a4d23eddfa"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#a60e59a9f46a1efa9885829a4d23eddfa">&#9670;&nbsp;</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&#160;</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>
+<h3>Usage</h3>
+<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><!-- fragment -->
+</div>
+</div>
+</div><!-- contents -->
+<!-- start footer part -->
+<hr class="footer"/><address class="footer"><small>
+Generated by &#160;<a href="http://www.doxygen.org/index.html">
+<img class="footer" src="doxygen.png" alt="doxygen"/>
+</a> 1.8.13
+</small></address>
+</body>
+</html>