summaryrefslogtreecommitdiff
path: root/apidocs/icalattach_8h_source.html
blob: c201c4e0b9b245018e9a12087534d6b0efda3c95 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
<!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: icalattach.h Source File</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="headertitle">
<div class="title">icalattach.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="icalattach_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>&#160;<span class="comment">/*======================================================================</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"> FILE: icalattach.h</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment"> CREATOR: acampi 28 May 02</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> (C) COPYRIGHT 2002, Andrea Campi &lt;a.campi@inet.it&gt;</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<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>&#160;<span class="comment"> it under the terms of either:</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<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>&#160;<span class="comment">    2.1, available at: http://www.gnu.org/licenses/lgpl-2.1.html</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> Or:</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"></span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<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>&#160;<span class="comment">    the License at http://www.mozilla.org/MPL/</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment">======================================================================*/</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;</div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="preprocessor">#ifndef ICALATTACH_H</span></div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="preprocessor">#define ICALATTACH_H</span></div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;</div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="preprocessor">#include &quot;libical_ical_export.h&quot;</span></div><div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;</div><div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="icalattach_8h.html#a56d5623c8bd51231d464b50cc69a72c5">   44</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structicalattach__impl.html">icalattach_impl</a> <a class="code" href="structicalattach__impl.html">icalattach</a>;</div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;</div><div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="icalattach_8h.html#a5594d24dde2b625bf4bf299f7e579190">   54</a></span>&#160;<span class="keyword">typedef</span> void (*<a class="code" href="icalattach_8h.html#a5594d24dde2b625bf4bf299f7e579190">icalattach_free_fn_t</a>) (<span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *data, <span class="keywordtype">void</span> *user_data);</div><div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;</div><div class="line"><a name="l00086"></a><span class="lineno">   86</span>&#160;LIBICAL_ICAL_EXPORT <a class="code" href="structicalattach__impl.html">icalattach</a> *<a class="code" href="icalattach_8h.html#a8fd3cb99bf67d17f3f11cc7b5f78f13b">icalattach_new_from_url</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *url);</div><div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;</div><div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;LIBICAL_ICAL_EXPORT <a class="code" href="structicalattach__impl.html">icalattach</a> *<a class="code" href="icalattach_8h.html#ab6274ba5df22dde512aaa5bb07f08464">icalattach_new_from_data</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *data,</div><div class="line"><a name="l00108"></a><span class="lineno">  108</span>&#160;                                                         <a class="code" href="icalattach_8h.html#a5594d24dde2b625bf4bf299f7e579190">icalattach_free_fn_t</a> free_fn,</div><div class="line"><a name="l00109"></a><span class="lineno">  109</span>&#160;                                                         <span class="keywordtype">void</span> *free_fn_data);</div><div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;</div><div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;LIBICAL_ICAL_EXPORT <span class="keywordtype">void</span> <a class="code" href="icalattach_8h.html#aa442cd17e95dd605f5df40194d910002">icalattach_ref</a>(<a class="code" href="structicalattach__impl.html">icalattach</a> *attach);</div><div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;</div><div class="line"><a name="l00152"></a><span class="lineno">  152</span>&#160;LIBICAL_ICAL_EXPORT <span class="keywordtype">void</span> <a class="code" href="icalattach_8h.html#a4f9e8fe048e58d1035f82ca47e51024f">icalattach_unref</a>(<a class="code" href="structicalattach__impl.html">icalattach</a> *attach);</div><div class="line"><a name="l00153"></a><span class="lineno">  153</span>&#160;</div><div class="line"><a name="l00176"></a><span class="lineno">  176</span>&#160;LIBICAL_ICAL_EXPORT <span class="keywordtype">int</span> <a class="code" href="icalattach_8h.html#a87aa30954aa1f901d90ab816abdfebd1">icalattach_get_is_url</a>(<a class="code" href="structicalattach__impl.html">icalattach</a> *attach);</div><div class="line"><a name="l00177"></a><span class="lineno">  177</span>&#160;</div><div class="line"><a name="l00208"></a><span class="lineno">  208</span>&#160;LIBICAL_ICAL_EXPORT <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code" href="icalattach_8h.html#ace086024b7d9e24e0052ccd7a6fc1d60">icalattach_get_url</a>(<a class="code" href="structicalattach__impl.html">icalattach</a> *attach);</div><div class="line"><a name="l00209"></a><span class="lineno">  209</span>&#160;</div><div class="line"><a name="l00227"></a><span class="lineno">  227</span>&#160;LIBICAL_ICAL_EXPORT <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *<a class="code" href="icalattach_8h.html#a04b7e2f7106af21ca2cc03b9040f9487">icalattach_get_data</a>(<a class="code" href="structicalattach__impl.html">icalattach</a> *attach);</div><div class="line"><a name="l00228"></a><span class="lineno">  228</span>&#160;</div><div class="line"><a name="l00229"></a><span class="lineno">  229</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* !ICALATTACH_H */</span><span class="preprocessor"></span></div><div class="ttc" id="icalattach_8h_html_a4f9e8fe048e58d1035f82ca47e51024f"><div class="ttname"><a href="icalattach_8h.html#a4f9e8fe048e58d1035f82ca47e51024f">icalattach_unref</a></div><div class="ttdeci">void icalattach_unref(icalattach *attach)</div><div class="ttdoc">Decrements reference count of the icalattach. </div><div class="ttdef"><b>Definition:</b> icalattach.c:90</div></div>
<div class="ttc" id="icalattach_8h_html_a5594d24dde2b625bf4bf299f7e579190"><div class="ttname"><a href="icalattach_8h.html#a5594d24dde2b625bf4bf299f7e579190">icalattach_free_fn_t</a></div><div class="ttdeci">void(* icalattach_free_fn_t)(unsigned char *data, void *user_data)</div><div class="ttdoc">(unused) Function to be called to free the data of an icalattach object.  Currently not used ...</div><div class="ttdef"><b>Definition:</b> icalattach.h:54</div></div>
<div class="ttc" id="icalattach_8h_html_a87aa30954aa1f901d90ab816abdfebd1"><div class="ttname"><a href="icalattach_8h.html#a87aa30954aa1f901d90ab816abdfebd1">icalattach_get_is_url</a></div><div class="ttdeci">int icalattach_get_is_url(icalattach *attach)</div><div class="ttdoc">Determines if attach is an URL. </div><div class="ttdef"><b>Definition:</b> icalattach.c:113</div></div>
<div class="ttc" id="icalattach_8h_html_ace086024b7d9e24e0052ccd7a6fc1d60"><div class="ttname"><a href="icalattach_8h.html#ace086024b7d9e24e0052ccd7a6fc1d60">icalattach_get_url</a></div><div class="ttdeci">const char * icalattach_get_url(icalattach *attach)</div><div class="ttdoc">Returns the URL of the icalattach object. </div><div class="ttdef"><b>Definition:</b> icalattach.c:120</div></div>
<div class="ttc" id="icalattach_8h_html_a04b7e2f7106af21ca2cc03b9040f9487"><div class="ttname"><a href="icalattach_8h.html#a04b7e2f7106af21ca2cc03b9040f9487">icalattach_get_data</a></div><div class="ttdeci">unsigned char * icalattach_get_data(icalattach *attach)</div><div class="ttdoc">Returns the data of the icalattach object. </div><div class="ttdef"><b>Definition:</b> icalattach.c:128</div></div>
<div class="ttc" id="icalattach_8h_html_a8fd3cb99bf67d17f3f11cc7b5f78f13b"><div class="ttname"><a href="icalattach_8h.html#a8fd3cb99bf67d17f3f11cc7b5f78f13b">icalattach_new_from_url</a></div><div class="ttdeci">icalattach * icalattach_new_from_url(const char *url)</div><div class="ttdoc">Create new icalattach object from a URL. </div><div class="ttdef"><b>Definition:</b> icalattach.c:29</div></div>
<div class="ttc" id="icalattach_8h_html_aa442cd17e95dd605f5df40194d910002"><div class="ttname"><a href="icalattach_8h.html#aa442cd17e95dd605f5df40194d910002">icalattach_ref</a></div><div class="ttdeci">void icalattach_ref(icalattach *attach)</div><div class="ttdoc">Increments reference count of the icalattach. </div><div class="ttdef"><b>Definition:</b> icalattach.c:82</div></div>
<div class="ttc" id="icalattach_8h_html_ab6274ba5df22dde512aaa5bb07f08464"><div class="ttname"><a href="icalattach_8h.html#ab6274ba5df22dde512aaa5bb07f08464">icalattach_new_from_data</a></div><div class="ttdeci">icalattach * icalattach_new_from_data(const char *data, icalattach_free_fn_t free_fn, void *free_fn_data)</div><div class="ttdoc">Create new icalattach object from data. </div><div class="ttdef"><b>Definition:</b> icalattach.c:54</div></div>
<div class="ttc" id="structicalattach__impl_html"><div class="ttname"><a href="structicalattach__impl.html">icalattach_impl</a></div><div class="ttdef"><b>Definition:</b> icalattachimpl.h:25</div></div>
</div><!-- fragment --></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>