diff options
Diffstat (limited to 'apidocs/icalspanlist_8h.html')
| -rw-r--r-- | apidocs/icalspanlist_8h.html | 359 |
1 files changed, 284 insertions, 75 deletions
diff --git a/apidocs/icalspanlist_8h.html b/apidocs/icalspanlist_8h.html index e41adf21..e82d2d49 100644 --- a/apidocs/icalspanlist_8h.html +++ b/apidocs/icalspanlist_8h.html @@ -3,17 +3,15 @@ <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.9.1"/> -<title>Libical: icalspanlist.h File Reference</title> +<meta name="generator" content="Doxygen 1.8.13"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>Libical API Documentation: icalspanlist.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> -<script type="text/javascript"> - $(document).ready(function() { init_search(); }); -</script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> @@ -22,9 +20,9 @@ <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> - <td style="padding-left: 0.5em;"> - <div id="projectname">Libical -  <span id="projectnumber">2.0</span> + <td id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">Libical API Documentation +  <span id="projectnumber">2.99</span> </div> </td> </tr> @@ -32,40 +30,19 @@ </table> </div> <!-- end header part --> -<!-- Generated by Doxygen 1.8.9.1 --> +<!-- Generated by Doxygen 1.8.13 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> - <div id="navrow1" class="tabs"> - <ul class="tablist"> - <li><a href="index.html"><span>Main Page</span></a></li> - <li><a href="pages.html"><span>Related Pages</span></a></li> - <li><a href="annotated.html"><span>Data Structures</span></a></li> - <li class="current"><a href="files.html"><span>Files</span></a></li> - <li> - <div id="MSearchBox" class="MSearchBoxInactive"> - <span class="left"> - <img id="MSearchSelect" src="search/mag_sel.png" - onmouseover="return searchBox.OnSearchSelectShow()" - onmouseout="return searchBox.OnSearchSelectHide()" - alt=""/> - <input type="text" id="MSearchField" value="Search" accesskey="S" - onfocus="searchBox.OnSearchFieldFocus(true)" - onblur="searchBox.OnSearchFieldFocus(false)" - onkeyup="searchBox.OnSearchFieldChange(event)"/> - </span><span class="right"> - <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> - </span> - </div> - </li> - </ul> - </div> - <div id="navrow2" class="tabs2"> - <ul class="tablist"> - <li><a href="files.html"><span>File List</span></a></li> - <li><a href="globals.html"><span>Globals</span></a></li> - </ul> - </div> +<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()" @@ -88,8 +65,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); <div class="header"> <div class="summary"> <a href="#typedef-members">Typedefs</a> | -<a href="#func-members">Functions</a> | -<a href="#var-members">Variables</a> </div> +<a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">icalspanlist.h File Reference</div> </div> </div><!--header--> @@ -97,65 +73,298 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); <p>Code that supports collections of free/busy spans of time. <a href="#details">More...</a></p> -<div class="textblock"><code>#include "libical_icalss_export.h"</code><br /> -<code>#include "<a class="el" href="icalset_8h_source.html">icalset.h</a>"</code><br /> -</div> + <p><a href="icalspanlist_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="typedef-members"></a> Typedefs</h2></td></tr> -<tr class="memitem:ab56eb13ccdb70ef4a7d6aede068d6fd4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab56eb13ccdb70ef4a7d6aede068d6fd4"></a> +<tr class="memitem:ab56eb13ccdb70ef4a7d6aede068d6fd4"><td class="memItemLeft" align="right" valign="top"><a id="ab56eb13ccdb70ef4a7d6aede068d6fd4"></a> typedef struct <a class="el" href="structicalspanlist__impl.html">icalspanlist_impl</a> </td><td class="memItemRight" valign="bottom"><b>icalspanlist</b></td></tr> <tr class="separator:ab56eb13ccdb70ef4a7d6aede068d6fd4"><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:a77628c26eed14c0b42607dae0c398e3b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="icalspanlist_8h.html#a77628c26eed14c0b42607dae0c398e3b">__attribute__</a> ((visibility("default"))) icalspanlist *icalspanlist_new(<a class="el" href="structicalset__impl.html">icalset</a> *set</td></tr> -<tr class="memdesc:a77628c26eed14c0b42607dae0c398e3b"><td class="mdescLeft"> </td><td class="mdescRight">Constructor Make a free list from a set of component. Start and end should be in UTC. <a href="#a77628c26eed14c0b42607dae0c398e3b">More...</a><br /></td></tr> -<tr class="separator:a77628c26eed14c0b42607dae0c398e3b"><td class="memSeparator" colspan="2"> </td></tr> -</table><table class="memberdecls"> -<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a> -Variables</h2></td></tr> -<tr class="memitem:a4e4b63aca754b6754db52a917860936a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4e4b63aca754b6754db52a917860936a"></a> -const char const char * </td><td class="memItemRight" valign="bottom"><b>attendee</b></td></tr> -<tr class="separator:a4e4b63aca754b6754db52a917860936a"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a9d3b6b18c128107811c20736052434e3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9d3b6b18c128107811c20736052434e3"></a> -int </td><td class="memItemRight" valign="bottom"><b>delta_t</b></td></tr> -<tr class="separator:a9d3b6b18c128107811c20736052434e3"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a7569b0795ba0b97021184d98372c2008"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7569b0795ba0b97021184d98372c2008"></a> -struct <a class="el" href="structicaltimetype.html">icaltimetype</a> start struct <a class="el" href="structicaltimetype.html">icaltimetype</a> </td><td class="memItemRight" valign="bottom"><b>end</b></td></tr> -<tr class="separator:a7569b0795ba0b97021184d98372c2008"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a308a76b591b82146695fe268588b9a49"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a308a76b591b82146695fe268588b9a49"></a> -const char * </td><td class="memItemRight" valign="bottom"><b>organizer</b></td></tr> -<tr class="separator:a308a76b591b82146695fe268588b9a49"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ae1e3d5f287ab4e24c64d986cfc09c38c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae1e3d5f287ab4e24c64d986cfc09c38c"></a> -struct <a class="el" href="structicaltimetype.html">icaltimetype</a> </td><td class="memItemRight" valign="bottom"><b>t</b></td></tr> -<tr class="separator:ae1e3d5f287ab4e24c64d986cfc09c38c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aca42fe723854f27dee1dbd89ac8eea43"><td class="memItemLeft" align="right" valign="top">int * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalspanlist_8h.html#aca42fe723854f27dee1dbd89ac8eea43">icalspanlist_as_freebusy_matrix</a> (<a class="el" href="structicalspanlist__impl.html">icalspanlist</a> *span, int delta_t)</td></tr> +<tr class="memdesc:aca42fe723854f27dee1dbd89ac8eea43"><td class="mdescLeft"> </td><td class="mdescRight">Return an integer matrix of total events per delta_t timespan. <a href="#aca42fe723854f27dee1dbd89ac8eea43">More...</a><br /></td></tr> +<tr class="separator:aca42fe723854f27dee1dbd89ac8eea43"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a2c5f900137f272a1897d8856fbd1b961"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalspanlist_8h.html#a2c5f900137f272a1897d8856fbd1b961">icalspanlist_as_vfreebusy</a> (<a class="el" href="structicalspanlist__impl.html">icalspanlist</a> *sl, const char *organizer, const char *attendee)</td></tr> +<tr class="memdesc:a2c5f900137f272a1897d8856fbd1b961"><td class="mdescLeft"> </td><td class="mdescRight">Return a valid VFREEBUSY component for this span. <a href="#a2c5f900137f272a1897d8856fbd1b961">More...</a><br /></td></tr> +<tr class="separator:a2c5f900137f272a1897d8856fbd1b961"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a5ad885ca2cbf81bfea72d04cf17b5010"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="icalspanlist_8h.html#a5ad885ca2cbf81bfea72d04cf17b5010">icalspanlist_dump</a> (<a class="el" href="structicalspanlist__impl.html">icalspanlist</a> *s)</td></tr> +<tr class="memdesc:a5ad885ca2cbf81bfea72d04cf17b5010"><td class="mdescLeft"> </td><td class="mdescRight">(Debug) print out spanlist to stdout. <a href="#a5ad885ca2cbf81bfea72d04cf17b5010">More...</a><br /></td></tr> +<tr class="separator:a5ad885ca2cbf81bfea72d04cf17b5010"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aacc49ed6cd735f495292f0cf3c464a4d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="icalspanlist_8h.html#aacc49ed6cd735f495292f0cf3c464a4d">icalspanlist_free</a> (<a class="el" href="structicalspanlist__impl.html">icalspanlist</a> *spl)</td></tr> +<tr class="memdesc:aacc49ed6cd735f495292f0cf3c464a4d"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#aacc49ed6cd735f495292f0cf3c464a4d">More...</a><br /></td></tr> +<tr class="separator:aacc49ed6cd735f495292f0cf3c464a4d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a7178dfde5839654471d57611794eda96"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structicalspanlist__impl.html">icalspanlist</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalspanlist_8h.html#a7178dfde5839654471d57611794eda96">icalspanlist_from_vfreebusy</a> (<a class="el" href="structicalcomponent__impl.html">icalcomponent</a> *comp)</td></tr> +<tr class="memdesc:a7178dfde5839654471d57611794eda96"><td class="mdescLeft"> </td><td class="mdescRight">Construct an icalspanlist from a VFREEBUSY component. <a href="#a7178dfde5839654471d57611794eda96">More...</a><br /></td></tr> +<tr class="separator:a7178dfde5839654471d57611794eda96"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae7f6d3e48e73cf9cd2712abd101400eb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structicalspanlist__impl.html">icalspanlist</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icalspanlist_8h.html#ae7f6d3e48e73cf9cd2712abd101400eb">icalspanlist_new</a> (<a class="el" href="structicalset__impl.html">icalset</a> *set, struct <a class="el" href="structicaltimetype.html">icaltimetype</a> start, struct <a class="el" href="structicaltimetype.html">icaltimetype</a> end)</td></tr> +<tr class="memdesc:ae7f6d3e48e73cf9cd2712abd101400eb"><td class="mdescLeft"> </td><td class="mdescRight">Constructor Make a free list from a set of component. Start and end should be in UTC. <a href="#ae7f6d3e48e73cf9cd2712abd101400eb">More...</a><br /></td></tr> +<tr class="separator:ae7f6d3e48e73cf9cd2712abd101400eb"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af8686abb751773c3358c1a82fb79606c"><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="icalspanlist_8h.html#af8686abb751773c3358c1a82fb79606c">icalspanlist_next_free_time</a> (<a class="el" href="structicalspanlist__impl.html">icalspanlist</a> *sl, struct <a class="el" href="structicaltimetype.html">icaltimetype</a> t)</td></tr> +<tr class="memdesc:af8686abb751773c3358c1a82fb79606c"><td class="mdescLeft"> </td><td class="mdescRight">Find next free time span in a spanlist. <a href="#af8686abb751773c3358c1a82fb79606c">More...</a><br /></td></tr> +<tr class="separator:af8686abb751773c3358c1a82fb79606c"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Code that supports collections of free/busy spans of time. </p> </div><h2 class="groupheader">Function Documentation</h2> -<a class="anchor" id="a77628c26eed14c0b42607dae0c398e3b"></a> +<a id="aca42fe723854f27dee1dbd89ac8eea43"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aca42fe723854f27dee1dbd89ac8eea43">◆ </a></span>icalspanlist_as_freebusy_matrix()</h2> + <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">__attribute__ </td> + <td class="memname">int* icalspanlist_as_freebusy_matrix </td> <td>(</td> - <td class="paramtype">(visibility("default")) </td> - <td class="paramname"></td><td>)</td> + <td class="paramtype"><a class="el" href="structicalspanlist__impl.html">icalspanlist</a> * </td> + <td class="paramname"><em>sl</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> <td></td> + <td class="paramtype">int </td> + <td class="paramname"><em>delta_t</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> </tr> </table> </div><div class="memdoc"> -<p>Constructor Make a free list from a set of component. Start and end should be in UTC. </p> -<p>Construct an icalspanlist from a VFREEBUSY component.</p> +<p>Return an integer matrix of total events per delta_t timespan. </p> <p>Return an integer matrix of total events per delta_t timespan.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">sl</td><td>A valid icalspanlist </td></tr> + <tr><td class="paramname">delta_t</td><td>The time slice to divide by, in seconds. Default 3600.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>A pointer to an array of integers containing the number of busy events in each delta_t time period. The final entry contains the value -1.</dd></dl> +<p>This calculation is somewhat tricky. This is due to the fact that the time range contains the start time, but does not contain the end time. To perform a proper calculation we subtract one second off the end times to get a true containing time.</p> +<p>Also note that if you supplying a spanlist that does not start or end on a time boundary divisible by delta_t you may get results that are not quite what you expect. </p> +<p>calculate the start and end time as time_t</p> +<p>insure that the time period falls on a time boundary divisable by delta_t</p> +<p>find the duration of this spanlist</p> +<p>malloc our matrix, add one extra slot for a final -1 </p> + +</div> +</div> +<a id="a2c5f900137f272a1897d8856fbd1b961"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a2c5f900137f272a1897d8856fbd1b961">◆ </a></span>icalspanlist_as_vfreebusy()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structicalcomponent__impl.html">icalcomponent</a>* icalspanlist_as_vfreebusy </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structicalspanlist__impl.html">icalspanlist</a> * </td> + <td class="paramname"><em>sl</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>organizer</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>attendee</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Return a valid VFREEBUSY component for this span. </p> <p>Return a valid VFREEBUSY component for this span.</p> -<p>Destructor.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">sl</td><td>A valid icalspanlist, from <a class="el" href="icalspanlist_8h.html#ae7f6d3e48e73cf9cd2712abd101400eb" title="Constructor Make a free list from a set of component. Start and end should be in UTC. ">icalspanlist_new()</a> </td></tr> + <tr><td class="paramname">organizer</td><td>The organizer specified as "MAILTO:user@domain" </td></tr> + <tr><td class="paramname">attendee</td><td>The attendee specified as "MAILTO:user@domain"</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>A valid icalcomponent or NULL.</dd></dl> +<p>This function returns a VFREEBUSY component for the given spanlist. The start time is mapped to DTSTART, the end time to DTEND. Each busy span is represented as a separate FREEBUSY entry. An attendee parameter is required, and organizer parameter is optional. </p> + +</div> +</div> +<a id="a5ad885ca2cbf81bfea72d04cf17b5010"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a5ad885ca2cbf81bfea72d04cf17b5010">◆ </a></span>icalspanlist_dump()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void icalspanlist_dump </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structicalspanlist__impl.html">icalspanlist</a> * </td> + <td class="paramname"><em>sl</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>(Debug) print out spanlist to stdout. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">sl</td><td>A valid icalspanlist. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a id="aacc49ed6cd735f495292f0cf3c464a4d"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aacc49ed6cd735f495292f0cf3c464a4d">◆ </a></span>icalspanlist_free()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void icalspanlist_free </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structicalspanlist__impl.html">icalspanlist</a> * </td> + <td class="paramname"><em>s</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Destructor. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">s</td><td>A valid icalspanlist</td></tr> + </table> + </dd> +</dl> +<p>Free memory associated with the spanlist </p> + +</div> +</div> +<a id="a7178dfde5839654471d57611794eda96"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a7178dfde5839654471d57611794eda96">◆ </a></span>icalspanlist_from_vfreebusy()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structicalspanlist__impl.html">icalspanlist</a>* icalspanlist_from_vfreebusy </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * </td> + <td class="paramname"><em>comp</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Construct an icalspanlist from a VFREEBUSY component. </p> +<p>Construct an icalspanlist from a VFREEBUSY component.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">comp</td><td>A valid icalcomponent.</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>A valid icalspanlist or NULL if no VFREEBUSY section. </dd></dl> + +</div> +</div> +<a id="ae7f6d3e48e73cf9cd2712abd101400eb"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ae7f6d3e48e73cf9cd2712abd101400eb">◆ </a></span>icalspanlist_new()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="structicalspanlist__impl.html">icalspanlist</a>* icalspanlist_new </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structicalset__impl.html">icalset</a> * </td> + <td class="paramname"><em>set</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">struct <a class="el" href="structicaltimetype.html">icaltimetype</a> </td> + <td class="paramname"><em>start</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">struct <a class="el" href="structicaltimetype.html">icaltimetype</a> </td> + <td class="paramname"><em>end</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Constructor Make a free list from a set of component. Start and end should be in UTC. </p> +<p>Constructor Make a free list from a set of component. Start and end should be in UTC.</p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">set</td><td>A valid icalset containing VEVENTS </td></tr> + <tr><td class="paramname">start</td><td>The free list starts at this date/time </td></tr> + <tr><td class="paramname">end</td><td>The free list ends at this date/time</td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>A spanlist corresponding to the VEVENTS</dd></dl> +<p>Given a set of components, a start time and an end time return a spanlist that contains the free/busy times. </p> + +</div> +</div> +<a id="af8686abb751773c3358c1a82fb79606c"></a> +<h2 class="memtitle"><span class="permalink"><a href="#af8686abb751773c3358c1a82fb79606c">◆ </a></span>icalspanlist_next_free_time()</h2> + +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">struct <a class="el" href="structicalperiodtype.html">icalperiodtype</a> icalspanlist_next_free_time </td> + <td>(</td> + <td class="paramtype"><a class="el" href="structicalspanlist__impl.html">icalspanlist</a> * </td> + <td class="paramname"><em>sl</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">struct <a class="el" href="structicaltimetype.html">icaltimetype</a> </td> + <td class="paramname"><em>t</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Find next free time span in a spanlist. </p> <p>Get first next free time after time t. all times are in UTC.</p> -<p>Get first next busy time after time t. all times are in UTC. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">sl</td><td>The spanlist to search. </td></tr> + <tr><td class="paramname">t</td><td>The time to start looking.</td></tr> + </table> + </dd> +</dl> +<p>Given a spanlist and a time, find the next period of time that is free </p> </div> </div> @@ -164,7 +373,7 @@ struct <a class="el" href="structicaltimetype.html">icaltimetype</a> </td>< <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.9.1 +</a> 1.8.13 </small></address> </body> </html> |