summaryrefslogtreecommitdiff
path: root/apidocs/icaltimezone_8h.html
blob: 419dda1aca685df53fa2cfca5e0f37b8d32b3e1e (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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
<!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.9.1"/>
<title>Libical: icaltimezone.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>
<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 style="padding-left: 0.5em;">
   <div id="projectname">Libical
   &#160;<span id="projectnumber">2.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<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&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;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&#160;List</span></a></li>
      <li><a href="globals.html"><span>Globals</span></a></li>
    </ul>
  </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="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> &#124;
<a href="#var-members">Variables</a>  </div>
  <div class="headertitle">
<div class="title">icaltimezone.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>timezone handling routines  
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;libical_ical_export.h&quot;</code><br />
<code>#include &quot;icalcomponent.h&quot;</code><br />
<code>#include &lt;stdio.h&gt;</code><br />
</div>
<p><a href="icaltimezone_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:a8561e9d4374ca1e29cd5ade459a50208"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8561e9d4374ca1e29cd5ade459a50208"></a>
typedef struct <a class="el" href="struct__icaltimezone.html">_icaltimezone</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#a8561e9d4374ca1e29cd5ade459a50208">icaltimezone</a></td></tr>
<tr class="memdesc:a8561e9d4374ca1e29cd5ade459a50208"><td class="mdescLeft">&#160;</td><td class="mdescRight">An opaque struct representing a timezone. We declare this here to avoid a circular dependancy. <br /></td></tr>
<tr class="separator:a8561e9d4374ca1e29cd5ade459a50208"><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:a603507da582421a684605bf7635212b3"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#a603507da582421a684605bf7635212b3">__attribute__</a> ((visibility(&quot;default&quot;))) icaltimezone *<a class="el" href="icaltimezone_8c.html#ac3a8d8fa9901d42ab989f1a1e746956c">icaltimezone_new</a>(void)</td></tr>
<tr class="memdesc:a603507da582421a684605bf7635212b3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Generic icalset constructor.  <a href="#a603507da582421a684605bf7635212b3">More...</a><br /></td></tr>
<tr class="separator:a603507da582421a684605bf7635212b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa91ac94068e5562fef581305551b2b24"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa91ac94068e5562fef581305551b2b24"></a>
const char *&#160;</td><td class="memItemRight" valign="bottom"><b>icaltimezone_tzid_prefix</b> (void)</td></tr>
<tr class="separator:aa91ac94068e5562fef581305551b2b24"><td class="memSeparator" colspan="2">&#160;</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:af521d6685bccf3be4a7aece27010db03"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af521d6685bccf3be4a7aece27010db03"></a>
int <a class="el" href="struct__icalarray.html">icalarray</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>changes</b></td></tr>
<tr class="separator:af521d6685bccf3be4a7aece27010db03"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d204367c4103c4e1b7e9847428ac901"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8d204367c4103c4e1b7e9847428ac901"></a>
<a class="el" href="structicalcomponent__impl.html">icalcomponent</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>child</b></td></tr>
<tr class="separator:a8d204367c4103c4e1b7e9847428ac901"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae30df2bcca4e48426c8ba1e4ad259e1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aae30df2bcca4e48426c8ba1e4ad259e1"></a>
<a class="el" href="structicalcomponent__impl.html">icalcomponent</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>comp</b></td></tr>
<tr class="separator:aae30df2bcca4e48426c8ba1e4ad259e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a74b8d0d2be2f27adaa1f79fb481db4ba"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a74b8d0d2be2f27adaa1f79fb481db4ba"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>end_year</b></td></tr>
<tr class="separator:a74b8d0d2be2f27adaa1f79fb481db4ba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab9a88b0f5cf945eb84e09d85f78f6453"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab9a88b0f5cf945eb84e09d85f78f6453"></a>
int FILE *&#160;</td><td class="memItemRight" valign="bottom"><b>fp</b></td></tr>
<tr class="separator:ab9a88b0f5cf945eb84e09d85f78f6453"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6bc8f4831eaf3c473b7abe40004006b3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a6bc8f4831eaf3c473b7abe40004006b3"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>free_struct</b></td></tr>
<tr class="separator:a6bc8f4831eaf3c473b7abe40004006b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3b875c05f7a69f11829acff85bf62bfa"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3b875c05f7a69f11829acff85bf62bfa"></a>
<a class="el" href="struct__icaltimezone.html">icaltimezone</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>from_zone</b></td></tr>
<tr class="separator:a3b875c05f7a69f11829acff85bf62bfa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0294201f7c22c499ad4303bd1c43ad1a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0294201f7c22c499ad4303bd1c43ad1a"></a>
struct <a class="el" href="structicaltimetype.html">icaltimetype</a> int *&#160;</td><td class="memItemRight" valign="bottom"><b>is_daylight</b></td></tr>
<tr class="separator:a0294201f7c22c499ad4303bd1c43ad1a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a01003dd56df6216d1cee8a51c462954a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a01003dd56df6216d1cee8a51c462954a"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>max_year</b></td></tr>
<tr class="separator:a01003dd56df6216d1cee8a51c462954a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af4814742d95f102ee6fb4a99bf0159a9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af4814742d95f102ee6fb4a99bf0159a9"></a>
<a class="el" href="struct__icaltimezone.html">icaltimezone</a> <a class="el" href="struct__icaltimezone.html">icaltimezone</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>to_zone</b></td></tr>
<tr class="separator:af4814742d95f102ee6fb4a99bf0159a9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0e2f7fedf404307df20cfffe1005e16c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0e2f7fedf404307df20cfffe1005e16c"></a>
struct <a class="el" href="structicaltimetype.html">icaltimetype</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>tt</b></td></tr>
<tr class="separator:a0e2f7fedf404307df20cfffe1005e16c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1d9973a289af7f5e81a88387d6430bdc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1d9973a289af7f5e81a88387d6430bdc"></a>
const char *&#160;</td><td class="memItemRight" valign="bottom"><b>tzname</b></td></tr>
<tr class="separator:a1d9973a289af7f5e81a88387d6430bdc"><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>timezone handling routines </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a603507da582421a684605bf7635212b3"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">__attribute__ </td>
          <td>(</td>
          <td class="paramtype">(visibility(&quot;default&quot;))&#160;</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Generic icalset constructor. </p>
<dl class="section user"><dt>Creating/Destroying individual icaltimezones.Creates a new icaltimezone. </dt><dd></dd></dl>
<p>Frees all memory used for the icaltimezone. Set free_struct to free the icaltimezone struct as well.</p>
<p>Sets the prefix to be used for tzid's generated from system tzdata. Must be globally unique (such as a domain name owned by the developer of the calling application), and begin and end with forward slashes. Do not change or de-allocate the string buffer after calling this.</p>
<dl class="section user"><dt>Accessing timezones.Free any builtin timezone information </dt><dd></dd></dl>
<p>Returns the array of builtin icaltimezones.</p>
<p>Returns a single builtin timezone, given its Olson city name.</p>
<p>Returns a single builtin timezone, given its offset.</p>
<p>Returns a single builtin timezone, given its TZID.</p>
<p>Returns the UTC timezone.</p>
<p>Returns the TZID of a timezone.</p>
<p>Returns the city name of a timezone.</p>
<p>Returns the TZNAME properties used in the latest STANDARD and DAYLIGHT components. If they are the same it will return just one, e.g. "LMT". If they are different it will format them like "EST/EDT". Note that this may also return NULL.</p>
<p>Returns the latitude of a builtin timezone.</p>
<p>Returns the longitude of a builtin timezone.</p>
<p>Returns the VTIMEZONE component of a timezone.</p>
<p>Sets the VTIMEZONE component of an icaltimezone, initializing the tzid, location &amp; tzname fields. It returns 1 on success or 0 on failure, i.e. no TZID was found.</p>
<dl class="section user"><dt>Converting times between timezones.</dt><dd></dd></dl>
<dl class="section user"><dt>Getting offsets from UTC. Calculates the UTC offset of a given local time in the given</dt><dd>timezone. It is the number of seconds to add to UTC to get local time. The is_daylight flag is set to 1 if the time is in daylight-savings time.</dd></dl>
<p>Calculates the UTC offset of a given UTC time in the given timezone. It is the number of seconds to add to UTC to get local time. The is_daylight flag is set to 1 if the time is in daylight-savings time.</p>
<p>Set the directory to look for the zonefiles</p>
<p>Free memory dedicated to the zonefile directory</p>
<p>Dumps information about changes in the timezone up to and including max_year. </p>

</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.9.1
</small></address>
</body>
</html>