diff options
Diffstat (limited to 'apidocs/icaldirset_8h_source.html')
| -rw-r--r-- | apidocs/icaldirset_8h_source.html | 240 |
1 files changed, 125 insertions, 115 deletions
diff --git a/apidocs/icaldirset_8h_source.html b/apidocs/icaldirset_8h_source.html index 1be7b1e8..8e34b333 100644 --- a/apidocs/icaldirset_8h_source.html +++ b/apidocs/icaldirset_8h_source.html @@ -2,8 +2,8 @@ <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=11"/> -<meta name="generator" content="Doxygen 1.9.3"/> +<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: icaldirset.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> @@ -19,9 +19,10 @@ <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> - <tr id="projectrow"> - <td id="projectalign"> - <div id="projectname">Libical API Documentation<span id="projectnumber"> 3.1</span> + <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> @@ -29,22 +30,21 @@ </table> </div> <!-- end header part --> -<!-- Generated by Doxygen 1.9.3 --> +<!-- Generated by Doxygen 1.9.1 --> <script type="text/javascript"> -/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ -var searchBox = new SearchBox("searchBox", "search",'Search','.html'); +/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ +/* @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> +/* @license-end */</script> <div id="main-nav"></div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" @@ -66,116 +66,126 @@ $(function() { </div> </div><!-- top --> <div class="header"> - <div class="headertitle"><div class="title">icaldirset.h</div></div> + <div class="headertitle"> +<div class="title">icaldirset.h</div> </div> </div><!--header--> <div class="contents"> -<a href="icaldirset_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*======================================================================</span></div> -<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> FILE: icaldirset.h</span></div> -<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> CREATOR: eric 28 November 1999</span></div> -<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"></span> </div> -<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> SPDX-FileCopyrightText: 2000, Eric Busboom <eric@civicknowledge.com></span></div> -<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"></span> </div> -<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> SPDX-License-Identifier: LGPL-2.1-only OR MPL-2.0</span></div> -<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"></span> </div> -<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> The Original Code is eric. The Initial Developer of the Original</span></div> -<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> Code is Eric Busboom</span></div> -<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment">======================================================================*/</span></div> -<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> </div> -<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="preprocessor">#ifndef ICALDIRSET_H</span></div> -<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="preprocessor">#define ICALDIRSET_H</span></div> -<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div> -<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="preprocessor">#include "libical_icalss_export.h"</span></div> -<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><span class="preprocessor">#include "<a class="code" href="icalset_8h.html">icalset.h</a>"</span></div> -<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> </div> -<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><span class="comment">/* icaldirset Routines for storing, fetching, and searching for ical</span></div> -<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><span class="comment"> * objects in a database */</span></div> -<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> </div> -<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structicaldirset__impl.html">icaldirset_impl</a> <a class="code hl_struct" href="structicaldirset__impl.html">icaldirset</a>;</div> -<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> </div> -<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span>LIBICAL_ICALSS_EXPORT <a class="code hl_struct" href="structicalset__impl.html">icalset</a> *icaldirset_new(<span class="keyword">const</span> <span class="keywordtype">char</span> *path);</div> -<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div> -<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span>LIBICAL_ICALSS_EXPORT <a class="code hl_struct" href="structicalset__impl.html">icalset</a> *icaldirset_new_reader(<span class="keyword">const</span> <span class="keywordtype">char</span> *path);</div> -<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> </div> -<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span>LIBICAL_ICALSS_EXPORT <a class="code hl_struct" href="structicalset__impl.html">icalset</a> *icaldirset_new_writer(<span class="keyword">const</span> <span class="keywordtype">char</span> *path);</div> -<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div> -<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span>LIBICAL_ICALSS_EXPORT <a class="code hl_struct" href="structicalset__impl.html">icalset</a> *icaldirset_init(<a class="code hl_struct" href="structicalset__impl.html">icalset</a> *set, <span class="keyword">const</span> <span class="keywordtype">char</span> *dsn, <span class="keywordtype">void</span> *<a class="code hl_variable" href="structicaldirset__impl.html#a38725a769403aec56b2b1a352c441ef1">options</a>);</div> -<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> </div> -<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span>LIBICAL_ICALSS_EXPORT <span class="keywordtype">void</span> icaldirset_free(<a class="code hl_struct" href="structicalset__impl.html">icalset</a> *set);</div> -<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span> </div> -<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span>LIBICAL_ICALSS_EXPORT <span class="keyword">const</span> <span class="keywordtype">char</span> *icaldirset_path(<a class="code hl_struct" href="structicalset__impl.html">icalset</a> *set);</div> -<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span> </div> -<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><span class="comment">/* Marks the cluster as changed, so it will be written to disk when it</span></div> -<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span><span class="comment"> is freed. Commit writes to disk immediately*/</span></div> -<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span>LIBICAL_ICALSS_EXPORT <span class="keywordtype">void</span> icaldirset_mark(<a class="code hl_struct" href="structicalset__impl.html">icalset</a> *set);</div> -<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span> </div> -<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span>LIBICAL_ICALSS_EXPORT <a class="code hl_enumeration" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833">icalerrorenum</a> icaldirset_commit(<a class="code hl_struct" href="structicalset__impl.html">icalset</a> *set);</div> -<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> </div> -<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span>LIBICAL_ICALSS_EXPORT <a class="code hl_enumeration" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833">icalerrorenum</a> <a class="code hl_function" href="icaldirset_8h.html#a123ff2d1b0887caafc027936bc9b921b">icaldirset_add_component</a>(<a class="code hl_struct" href="structicalset__impl.html">icalset</a> *store, <a class="code hl_struct" href="structicalcomponent__impl.html">icalcomponent</a> *comp);</div> -<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span>LIBICAL_ICALSS_EXPORT <a class="code hl_enumeration" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833">icalerrorenum</a> <a class="code hl_function" href="icaldirset_8h.html#ae3b06ab0380ffb7c0e4b7ce9251931ad">icaldirset_remove_component</a>(<a class="code hl_struct" href="structicalset__impl.html">icalset</a> *store,</div> -<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span> <a class="code hl_struct" href="structicalcomponent__impl.html">icalcomponent</a> *comp);</div> -<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span> </div> -<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span>LIBICAL_ICALSS_EXPORT <span class="keywordtype">int</span> icaldirset_count_components(<a class="code hl_struct" href="structicalset__impl.html">icalset</a> *store, icalcomponent_kind kind);</div> -<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span> </div> -<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span><span class="comment">/* Restricts the component returned by icaldirset_first, _next to those</span></div> -<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span><span class="comment"> that pass the gauge. _clear removes the gauge. */</span></div> -<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span>LIBICAL_ICALSS_EXPORT <a class="code hl_enumeration" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833">icalerrorenum</a> icaldirset_select(<a class="code hl_struct" href="structicalset__impl.html">icalset</a> *store, <a class="code hl_struct" href="structicalgauge__impl.html">icalgauge</a> *<a class="code hl_variable" href="structicaldirset__impl.html#a6f7d408d2b1b1309b9a74208aa0ddef4">gauge</a>);</div> -<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> </div> -<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span>LIBICAL_ICALSS_EXPORT <span class="keywordtype">void</span> icaldirset_clear(<a class="code hl_struct" href="structicalset__impl.html">icalset</a> *store);</div> -<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span> </div> -<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span><span class="comment">/* Gets a component by uid */</span></div> -<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span>LIBICAL_ICALSS_EXPORT <a class="code hl_struct" href="structicalcomponent__impl.html">icalcomponent</a> *icaldirset_fetch(<a class="code hl_struct" href="structicalset__impl.html">icalset</a> *store,</div> -<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span> icalcomponent_kind kind, <span class="keyword">const</span> <span class="keywordtype">char</span> *uid);</div> -<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span> </div> -<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span>LIBICAL_ICALSS_EXPORT <span class="keywordtype">int</span> icaldirset_has_uid(<a class="code hl_struct" href="structicalset__impl.html">icalset</a> *store, <span class="keyword">const</span> <span class="keywordtype">char</span> *uid);</div> -<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span> </div> -<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span>LIBICAL_ICALSS_EXPORT <a class="code hl_struct" href="structicalcomponent__impl.html">icalcomponent</a> *icaldirset_fetch_match(<a class="code hl_struct" href="structicalset__impl.html">icalset</a> *set, <a class="code hl_struct" href="structicalcomponent__impl.html">icalcomponent</a> *c);</div> -<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> </div> -<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span><span class="comment">/* Modifies components according to the MODIFY method of CAP. Works on</span></div> -<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span><span class="comment"> the currently selected components. */</span></div> -<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span>LIBICAL_ICALSS_EXPORT <a class="code hl_enumeration" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833">icalerrorenum</a> icaldirset_modify(<a class="code hl_struct" href="structicalset__impl.html">icalset</a> *store,</div> -<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> <a class="code hl_struct" href="structicalcomponent__impl.html">icalcomponent</a> *oldc, <a class="code hl_struct" href="structicalcomponent__impl.html">icalcomponent</a> *newc);</div> -<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span> </div> -<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span><span class="comment">/* Iterates through the components. If a gauge has been defined, these</span></div> -<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span><span class="comment"> will skip over components that do not pass the gauge */</span></div> -<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span> </div> -<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span>LIBICAL_ICALSS_EXPORT <a class="code hl_struct" href="structicalcomponent__impl.html">icalcomponent</a> *icaldirset_get_current_component(<a class="code hl_struct" href="structicalset__impl.html">icalset</a> *store);</div> -<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span> </div> -<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span>LIBICAL_ICALSS_EXPORT <a class="code hl_struct" href="structicalcomponent__impl.html">icalcomponent</a> *icaldirset_get_first_component(<a class="code hl_struct" href="structicalset__impl.html">icalset</a> *store);</div> -<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span> </div> -<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span>LIBICAL_ICALSS_EXPORT <a class="code hl_struct" href="structicalcomponent__impl.html">icalcomponent</a> *icaldirset_get_next_component(<a class="code hl_struct" href="structicalset__impl.html">icalset</a> *store);</div> -<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span> </div> -<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span><span class="comment">/* External iterator for thread safety */</span></div> -<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span>LIBICAL_ICALSS_EXPORT <a class="code hl_struct" href="structicalsetiter.html">icalsetiter</a> icaldirset_begin_component(<a class="code hl_struct" href="structicalset__impl.html">icalset</a> *set,</div> -<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> icalcomponent_kind kind,</div> -<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span> <a class="code hl_struct" href="structicalgauge__impl.html">icalgauge</a> *<a class="code hl_variable" href="structicaldirset__impl.html#a6f7d408d2b1b1309b9a74208aa0ddef4">gauge</a>, <span class="keyword">const</span> <span class="keywordtype">char</span> *tzid);</div> -<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span> </div> -<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span>LIBICAL_ICALSS_EXPORT <a class="code hl_struct" href="structicalcomponent__impl.html">icalcomponent</a> *icaldirsetiter_to_next(<a class="code hl_struct" href="structicalset__impl.html">icalset</a> *set, <a class="code hl_struct" href="structicalsetiter.html">icalsetiter</a> *i);</div> -<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span> </div> -<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span>LIBICAL_ICALSS_EXPORT <a class="code hl_struct" href="structicalcomponent__impl.html">icalcomponent</a> *icaldirsetiter_to_prior(<a class="code hl_struct" href="structicalset__impl.html">icalset</a> *set, <a class="code hl_struct" href="structicalsetiter.html">icalsetiter</a> *i);</div> -<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span> </div> -<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"><a class="line" href="structicaldirset__options.html"> 116</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code hl_struct" href="structicaldirset__options.html">icaldirset_options</a></div> -<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span>{</div> -<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"><a class="line" href="structicaldirset__options.html#a0198ec47b0288039a835e8fd5cfd2df0"> 118</a></span> <span class="keywordtype">int</span> <a class="code hl_variable" href="structicaldirset__options.html#a0198ec47b0288039a835e8fd5cfd2df0">flags</a>; </div> -<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span>} <a class="code hl_struct" href="structicaldirset__options.html">icaldirset_options</a>;</div> -<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span> </div> -<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span><span class="preprocessor">#endif </span><span class="comment">/* !ICALDIRSET_H */</span><span class="preprocessor"></span></div> -<div class="ttc" id="aicaldirset_8h_html_a123ff2d1b0887caafc027936bc9b921b"><div class="ttname"><a href="icaldirset_8h.html#a123ff2d1b0887caafc027936bc9b921b">icaldirset_add_component</a></div><div class="ttdeci">icalerrorenum icaldirset_add_component(icalset *store, icalcomponent *comp)</div><div class="ttdef"><b>Definition:</b> icaldirset.c:288</div></div> -<div class="ttc" id="aicaldirset_8h_html_ae3b06ab0380ffb7c0e4b7ce9251931ad"><div class="ttname"><a href="icaldirset_8h.html#ae3b06ab0380ffb7c0e4b7ce9251931ad">icaldirset_remove_component</a></div><div class="ttdeci">icalerrorenum icaldirset_remove_component(icalset *store, icalcomponent *comp)</div><div class="ttdef"><b>Definition:</b> icaldirset.c:375</div></div> -<div class="ttc" id="aicalerror_8h_html_a601c122fcea522513b1b7732fa23e833"><div class="ttname"><a href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833">icalerrorenum</a></div><div class="ttdeci">icalerrorenum</div><div class="ttdoc">Represents the different types of errors that can be triggered in libical.</div><div class="ttdef"><b>Definition:</b> icalerror.h:67</div></div> +<a href="icaldirset_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*======================================================================</span></div> +<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> FILE: icaldirset.h</span></div> +<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> CREATOR: eric 28 November 1999</span></div> +<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"></span> </div> +<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> (C) COPYRIGHT 2000, Eric Busboom <eric@civicknowledge.com></span></div> +<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"></span> </div> +<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> This library is free software; you can redistribute it and/or modify</span></div> +<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> it under the terms of either:</span></div> +<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"></span> </div> +<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> The LGPL as published by the Free Software Foundation, version</span></div> +<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> 2.1, available at: https://www.gnu.org/licenses/lgpl-2.1.html</span></div> +<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"></span> </div> +<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> Or:</span></div> +<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"></span> </div> +<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> The Mozilla Public License Version 2.0. You may obtain a copy of</span></div> +<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> the License at https://www.mozilla.org/MPL/</span></div> +<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"></span> </div> +<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> The Original Code is eric. The Initial Developer of the Original</span></div> +<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> Code is Eric Busboom</span></div> +<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">======================================================================*/</span></div> +<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  </div> +<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor">#ifndef ICALDIRSET_H</span></div> +<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor">#define ICALDIRSET_H</span></div> +<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  </div> +<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor">#include "libical_icalss_export.h"</span></div> +<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="preprocessor">#include "<a class="code" href="icalset_8h.html">icalset.h</a>"</span></div> +<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  </div> +<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment">/* icaldirset Routines for storing, fetching, and searching for ical</span></div> +<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> * objects in a database */</span></div> +<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  </div> +<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structicaldirset__impl.html">icaldirset_impl</a> <a class="code" href="structicaldirset__impl.html">icaldirset</a>;</div> +<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  </div> +<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> LIBICAL_ICALSS_EXPORT <a class="code" href="structicalset__impl.html">icalset</a> *icaldirset_new(<span class="keyword">const</span> <span class="keywordtype">char</span> *path);</div> +<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  </div> +<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> LIBICAL_ICALSS_EXPORT <a class="code" href="structicalset__impl.html">icalset</a> *icaldirset_new_reader(<span class="keyword">const</span> <span class="keywordtype">char</span> *path);</div> +<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  </div> +<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> LIBICAL_ICALSS_EXPORT <a class="code" href="structicalset__impl.html">icalset</a> *icaldirset_new_writer(<span class="keyword">const</span> <span class="keywordtype">char</span> *path);</div> +<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  </div> +<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> LIBICAL_ICALSS_EXPORT <a class="code" href="structicalset__impl.html">icalset</a> *icaldirset_init(<a class="code" href="structicalset__impl.html">icalset</a> *set, <span class="keyword">const</span> <span class="keywordtype">char</span> *dsn, <span class="keywordtype">void</span> *<a class="code" href="structicaldirset__impl.html#a38725a769403aec56b2b1a352c441ef1">options</a>);</div> +<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  </div> +<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> LIBICAL_ICALSS_EXPORT <span class="keywordtype">void</span> icaldirset_free(<a class="code" href="structicalset__impl.html">icalset</a> *set);</div> +<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  </div> +<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> LIBICAL_ICALSS_EXPORT <span class="keyword">const</span> <span class="keywordtype">char</span> *icaldirset_path(<a class="code" href="structicalset__impl.html">icalset</a> *set);</div> +<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  </div> +<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment">/* Marks the cluster as changed, so it will be written to disk when it</span></div> +<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> is freed. Commit writes to disk immediately*/</span></div> +<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> LIBICAL_ICALSS_EXPORT <span class="keywordtype">void</span> icaldirset_mark(<a class="code" href="structicalset__impl.html">icalset</a> *set);</div> +<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  </div> +<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> LIBICAL_ICALSS_EXPORT <a class="code" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833">icalerrorenum</a> icaldirset_commit(<a class="code" href="structicalset__impl.html">icalset</a> *set);</div> +<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  </div> +<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> LIBICAL_ICALSS_EXPORT <a class="code" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833">icalerrorenum</a> <a class="code" href="icaldirset_8h.html#a123ff2d1b0887caafc027936bc9b921b">icaldirset_add_component</a>(<a class="code" href="structicalset__impl.html">icalset</a> *store, <a class="code" href="structicalcomponent__impl.html">icalcomponent</a> *comp);</div> +<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> LIBICAL_ICALSS_EXPORT <a class="code" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833">icalerrorenum</a> <a class="code" href="icaldirset_8h.html#ae3b06ab0380ffb7c0e4b7ce9251931ad">icaldirset_remove_component</a>(<a class="code" href="structicalset__impl.html">icalset</a> *store,</div> +<div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <a class="code" href="structicalcomponent__impl.html">icalcomponent</a> *comp);</div> +<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  </div> +<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> LIBICAL_ICALSS_EXPORT <span class="keywordtype">int</span> icaldirset_count_components(<a class="code" href="structicalset__impl.html">icalset</a> *store, icalcomponent_kind kind);</div> +<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  </div> +<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment">/* Restricts the component returned by icaldirset_first, _next to those</span></div> +<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> that pass the gauge. _clear removes the gauge. */</span></div> +<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> LIBICAL_ICALSS_EXPORT <a class="code" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833">icalerrorenum</a> icaldirset_select(<a class="code" href="structicalset__impl.html">icalset</a> *store, <a class="code" href="structicalgauge__impl.html">icalgauge</a> *<a class="code" href="structicaldirset__impl.html#a6f7d408d2b1b1309b9a74208aa0ddef4">gauge</a>);</div> +<div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  </div> +<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> LIBICAL_ICALSS_EXPORT <span class="keywordtype">void</span> icaldirset_clear(<a class="code" href="structicalset__impl.html">icalset</a> *store);</div> +<div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  </div> +<div class="line"><a name="l00094"></a><span class="lineno"> 94</span> <span class="comment">/* Gets a component by uid */</span></div> +<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> LIBICAL_ICALSS_EXPORT <a class="code" href="structicalcomponent__impl.html">icalcomponent</a> *icaldirset_fetch(<a class="code" href="structicalset__impl.html">icalset</a> *store,</div> +<div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  icalcomponent_kind kind, <span class="keyword">const</span> <span class="keywordtype">char</span> *uid);</div> +<div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  </div> +<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> LIBICAL_ICALSS_EXPORT <span class="keywordtype">int</span> icaldirset_has_uid(<a class="code" href="structicalset__impl.html">icalset</a> *store, <span class="keyword">const</span> <span class="keywordtype">char</span> *uid);</div> +<div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  </div> +<div class="line"><a name="l00100"></a><span class="lineno"> 100</span> LIBICAL_ICALSS_EXPORT <a class="code" href="structicalcomponent__impl.html">icalcomponent</a> *icaldirset_fetch_match(<a class="code" href="structicalset__impl.html">icalset</a> *set, <a class="code" href="structicalcomponent__impl.html">icalcomponent</a> *c);</div> +<div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  </div> +<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment">/* Modifies components according to the MODIFY method of CAP. Works on</span></div> +<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> the currently selected components. */</span></div> +<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> LIBICAL_ICALSS_EXPORT <a class="code" href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833">icalerrorenum</a> icaldirset_modify(<a class="code" href="structicalset__impl.html">icalset</a> *store,</div> +<div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <a class="code" href="structicalcomponent__impl.html">icalcomponent</a> *oldc, <a class="code" href="structicalcomponent__impl.html">icalcomponent</a> *newc);</div> +<div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  </div> +<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment">/* Iterates through the components. If a gauge has been defined, these</span></div> +<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment"> will skip over components that do not pass the gauge */</span></div> +<div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  </div> +<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> LIBICAL_ICALSS_EXPORT <a class="code" href="structicalcomponent__impl.html">icalcomponent</a> *icaldirset_get_current_component(<a class="code" href="structicalset__impl.html">icalset</a> *store);</div> +<div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  </div> +<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> LIBICAL_ICALSS_EXPORT <a class="code" href="structicalcomponent__impl.html">icalcomponent</a> *icaldirset_get_first_component(<a class="code" href="structicalset__impl.html">icalset</a> *store);</div> +<div class="line"><a name="l00113"></a><span class="lineno"> 113</span>  </div> +<div class="line"><a name="l00114"></a><span class="lineno"> 114</span> LIBICAL_ICALSS_EXPORT <a class="code" href="structicalcomponent__impl.html">icalcomponent</a> *icaldirset_get_next_component(<a class="code" href="structicalset__impl.html">icalset</a> *store);</div> +<div class="line"><a name="l00115"></a><span class="lineno"> 115</span>  </div> +<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment">/* External iterator for thread safety */</span></div> +<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> LIBICAL_ICALSS_EXPORT <a class="code" href="structicalsetiter.html">icalsetiter</a> icaldirset_begin_component(<a class="code" href="structicalset__impl.html">icalset</a> *set,</div> +<div class="line"><a name="l00118"></a><span class="lineno"> 118</span>  icalcomponent_kind kind,</div> +<div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  <a class="code" href="structicalgauge__impl.html">icalgauge</a> *<a class="code" href="structicaldirset__impl.html#a6f7d408d2b1b1309b9a74208aa0ddef4">gauge</a>, <span class="keyword">const</span> <span class="keywordtype">char</span> *tzid);</div> +<div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  </div> +<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> LIBICAL_ICALSS_EXPORT <a class="code" href="structicalcomponent__impl.html">icalcomponent</a> *icaldirsetiter_to_next(<a class="code" href="structicalset__impl.html">icalset</a> *set, <a class="code" href="structicalsetiter.html">icalsetiter</a> *i);</div> +<div class="line"><a name="l00122"></a><span class="lineno"> 122</span>  </div> +<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> LIBICAL_ICALSS_EXPORT <a class="code" href="structicalcomponent__impl.html">icalcomponent</a> *icaldirsetiter_to_prior(<a class="code" href="structicalset__impl.html">icalset</a> *set, <a class="code" href="structicalsetiter.html">icalsetiter</a> *i);</div> +<div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  </div> +<div class="line"><a name="l00125"></a><span class="lineno"><a class="line" href="structicaldirset__options.html"> 125</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structicaldirset__options.html">icaldirset_options</a></div> +<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> {</div> +<div class="line"><a name="l00127"></a><span class="lineno"><a class="line" href="structicaldirset__options.html#a0198ec47b0288039a835e8fd5cfd2df0"> 127</a></span>  <span class="keywordtype">int</span> <a class="code" href="structicaldirset__options.html#a0198ec47b0288039a835e8fd5cfd2df0">flags</a>; </div> +<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> } <a class="code" href="structicaldirset__options.html">icaldirset_options</a>;</div> +<div class="line"><a name="l00129"></a><span class="lineno"> 129</span>  </div> +<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="preprocessor">#endif </span><span class="comment">/* !ICALDIRSET_H */</span><span class="preprocessor"></span></div> +<div class="ttc" id="aicaldirset_8h_html_a123ff2d1b0887caafc027936bc9b921b"><div class="ttname"><a href="icaldirset_8h.html#a123ff2d1b0887caafc027936bc9b921b">icaldirset_add_component</a></div><div class="ttdeci">icalerrorenum icaldirset_add_component(icalset *store, icalcomponent *comp)</div><div class="ttdef"><b>Definition:</b> icaldirset.c:297</div></div> +<div class="ttc" id="aicaldirset_8h_html_ae3b06ab0380ffb7c0e4b7ce9251931ad"><div class="ttname"><a href="icaldirset_8h.html#ae3b06ab0380ffb7c0e4b7ce9251931ad">icaldirset_remove_component</a></div><div class="ttdeci">icalerrorenum icaldirset_remove_component(icalset *store, icalcomponent *comp)</div><div class="ttdef"><b>Definition:</b> icaldirset.c:384</div></div> +<div class="ttc" id="aicalerror_8h_html_a601c122fcea522513b1b7732fa23e833"><div class="ttname"><a href="icalerror_8h.html#a601c122fcea522513b1b7732fa23e833">icalerrorenum</a></div><div class="ttdeci">icalerrorenum</div><div class="ttdoc">Represents the different types of errors that can be triggered in libical.</div><div class="ttdef"><b>Definition:</b> icalerror.h:76</div></div> <div class="ttc" id="aicalset_8h_html"><div class="ttname"><a href="icalset_8h.html">icalset.h</a></div></div> -<div class="ttc" id="astructicalcomponent__impl_html"><div class="ttname"><a href="structicalcomponent__impl.html">icalcomponent_impl</a></div><div class="ttdef"><b>Definition:</b> icalcomponent.c:28</div></div> -<div class="ttc" id="astructicaldirset__impl_html"><div class="ttname"><a href="structicaldirset__impl.html">icaldirset_impl</a></div><div class="ttdef"><b>Definition:</b> icaldirsetimpl.h:22</div></div> -<div class="ttc" id="astructicaldirset__impl_html_a38725a769403aec56b2b1a352c441ef1"><div class="ttname"><a href="structicaldirset__impl.html#a38725a769403aec56b2b1a352c441ef1">icaldirset_impl::options</a></div><div class="ttdeci">icaldirset_options options</div><div class="ttdef"><b>Definition:</b> icaldirsetimpl.h:25</div></div> -<div class="ttc" id="astructicaldirset__impl_html_a6f7d408d2b1b1309b9a74208aa0ddef4"><div class="ttname"><a href="structicaldirset__impl.html#a6f7d408d2b1b1309b9a74208aa0ddef4">icaldirset_impl::gauge</a></div><div class="ttdeci">icalgauge * gauge</div><div class="ttdef"><b>Definition:</b> icaldirsetimpl.h:27</div></div> -<div class="ttc" id="astructicaldirset__options_html"><div class="ttname"><a href="structicaldirset__options.html">icaldirset_options</a></div><div class="ttdef"><b>Definition:</b> icaldirset.h:117</div></div> -<div class="ttc" id="astructicaldirset__options_html_a0198ec47b0288039a835e8fd5cfd2df0"><div class="ttname"><a href="structicaldirset__options.html#a0198ec47b0288039a835e8fd5cfd2df0">icaldirset_options::flags</a></div><div class="ttdeci">int flags</div><div class="ttdef"><b>Definition:</b> icaldirset.h:118</div></div> -<div class="ttc" id="astructicalgauge__impl_html"><div class="ttname"><a href="structicalgauge__impl.html">icalgauge_impl</a></div><div class="ttdef"><b>Definition:</b> icalgaugeimpl.h:47</div></div> -<div class="ttc" id="astructicalset__impl_html"><div class="ttname"><a href="structicalset__impl.html">icalset_impl</a></div><div class="ttdef"><b>Definition:</b> icalset.h:52</div></div> -<div class="ttc" id="astructicalsetiter_html"><div class="ttname"><a href="structicalsetiter.html">icalsetiter</a></div><div class="ttdef"><b>Definition:</b> icalset.h:43</div></div> +<div class="ttc" id="astructicalcomponent__impl_html"><div class="ttname"><a href="structicalcomponent__impl.html">icalcomponent_impl</a></div><div class="ttdef"><b>Definition:</b> icalcomponent.c:36</div></div> +<div class="ttc" id="astructicaldirset__impl_html"><div class="ttname"><a href="structicaldirset__impl.html">icaldirset_impl</a></div><div class="ttdef"><b>Definition:</b> icaldirsetimpl.h:31</div></div> +<div class="ttc" id="astructicaldirset__impl_html_a38725a769403aec56b2b1a352c441ef1"><div class="ttname"><a href="structicaldirset__impl.html#a38725a769403aec56b2b1a352c441ef1">icaldirset_impl::options</a></div><div class="ttdeci">icaldirset_options options</div><div class="ttdef"><b>Definition:</b> icaldirsetimpl.h:34</div></div> +<div class="ttc" id="astructicaldirset__impl_html_a6f7d408d2b1b1309b9a74208aa0ddef4"><div class="ttname"><a href="structicaldirset__impl.html#a6f7d408d2b1b1309b9a74208aa0ddef4">icaldirset_impl::gauge</a></div><div class="ttdeci">icalgauge * gauge</div><div class="ttdef"><b>Definition:</b> icaldirsetimpl.h:36</div></div> +<div class="ttc" id="astructicaldirset__options_html"><div class="ttname"><a href="structicaldirset__options.html">icaldirset_options</a></div><div class="ttdef"><b>Definition:</b> icaldirset.h:126</div></div> +<div class="ttc" id="astructicaldirset__options_html_a0198ec47b0288039a835e8fd5cfd2df0"><div class="ttname"><a href="structicaldirset__options.html#a0198ec47b0288039a835e8fd5cfd2df0">icaldirset_options::flags</a></div><div class="ttdeci">int flags</div><div class="ttdef"><b>Definition:</b> icaldirset.h:127</div></div> +<div class="ttc" id="astructicalgauge__impl_html"><div class="ttname"><a href="structicalgauge__impl.html">icalgauge_impl</a></div><div class="ttdef"><b>Definition:</b> icalgaugeimpl.h:55</div></div> +<div class="ttc" id="astructicalset__impl_html"><div class="ttname"><a href="structicalset__impl.html">icalset_impl</a></div><div class="ttdef"><b>Definition:</b> icalset.h:61</div></div> +<div class="ttc" id="astructicalsetiter_html"><div class="ttname"><a href="structicalsetiter.html">icalsetiter</a></div><div class="ttdef"><b>Definition:</b> icalset.h:52</div></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> -Generated on Sat Jun 25 2022 08:55:43 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 Thu Oct 6 2022 14:47:00 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> |