summaryrefslogtreecommitdiff
path: root/apidocs/struct__icaltimezone.html
blob: c02bc7b6548e34b7d083713bf871ba02c7364631 (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
214
215
216
217
218
219
220
221
222
223
224
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Libical API Documentation: _icaltimezone Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Libical API Documentation
   &#160;<span id="projectnumber">3.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</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><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">_icaltimezone Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a3c2dfe057f0cf02a612552b6d2e87a75"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct__icaltimezone.html">icaltimezone</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__icaltimezone.html#a3c2dfe057f0cf02a612552b6d2e87a75">builtin_timezone</a></td></tr>
<tr class="separator:a3c2dfe057f0cf02a612552b6d2e87a75"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a841b16536a64c2c620e765079ca21d11"><td class="memItemLeft" align="right" valign="top"><a class="el" href="icalarray_8h.html#ad36143942d5ac4709b68fff41615e598">icalarray</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__icaltimezone.html#a841b16536a64c2c620e765079ca21d11">changes</a></td></tr>
<tr class="separator:a841b16536a64c2c620e765079ca21d11"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5c66736445277e7cc3bb8c45c32b7b14"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structicalcomponent__impl.html">icalcomponent</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__icaltimezone.html#a5c66736445277e7cc3bb8c45c32b7b14">component</a></td></tr>
<tr class="separator:a5c66736445277e7cc3bb8c45c32b7b14"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af13e59b4c5f832286020da795b819e11"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__icaltimezone.html#af13e59b4c5f832286020da795b819e11">end_year</a></td></tr>
<tr class="separator:af13e59b4c5f832286020da795b819e11"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abe274afa9aaa337634a84f7c6a5f5476"><td class="memItemLeft" align="right" valign="top"><a id="abe274afa9aaa337634a84f7c6a5f5476"></a>
double&#160;</td><td class="memItemRight" valign="bottom"><b>latitude</b></td></tr>
<tr class="separator:abe274afa9aaa337634a84f7c6a5f5476"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a90fc30929090b330fe1419602a0d7528"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__icaltimezone.html#a90fc30929090b330fe1419602a0d7528">location</a></td></tr>
<tr class="separator:a90fc30929090b330fe1419602a0d7528"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a36ccaf1d81c7ec0463ed9ccf3eead700"><td class="memItemLeft" align="right" valign="top">double&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__icaltimezone.html#a36ccaf1d81c7ec0463ed9ccf3eead700">longitude</a></td></tr>
<tr class="separator:a36ccaf1d81c7ec0463ed9ccf3eead700"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac863b840b171d996da68da6bfa664f89"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__icaltimezone.html#ac863b840b171d996da68da6bfa664f89">tzid</a></td></tr>
<tr class="separator:ac863b840b171d996da68da6bfa664f89"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7f30b657860b6bc98bdfd616c64eb20c"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct__icaltimezone.html#a7f30b657860b6bc98bdfd616c64eb20c">tznames</a></td></tr>
<tr class="separator:a7f30b657860b6bc98bdfd616c64eb20c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Field Documentation</h2>
<a id="a3c2dfe057f0cf02a612552b6d2e87a75"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3c2dfe057f0cf02a612552b6d2e87a75">&#9670;&nbsp;</a></span>builtin_timezone</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct__icaltimezone.html">icaltimezone</a>* _icaltimezone::builtin_timezone</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>If this is not NULL it points to the builtin icaltimezone that the above TZID refers to. This icaltimezone should be used instead when accessing the timezone changes data, so that the expanded timezone changes data is shared between calendar components. </p>

</div>
</div>
<a id="a841b16536a64c2c620e765079ca21d11"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a841b16536a64c2c620e765079ca21d11">&#9670;&nbsp;</a></span>changes</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="icalarray_8h.html#ad36143942d5ac4709b68fff41615e598">icalarray</a>* _icaltimezone::changes</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>A dynamically-allocated array of time zone changes, sorted by the time of the change in local time. So we can do fast binary-searches to convert from local time to UTC. </p>

</div>
</div>
<a id="a5c66736445277e7cc3bb8c45c32b7b14"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5c66736445277e7cc3bb8c45c32b7b14">&#9670;&nbsp;</a></span>component</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structicalcomponent__impl.html">icalcomponent</a>* _icaltimezone::component</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The toplevel VTIMEZONE component loaded from the .ics file for this timezone. If we need to regenerate the changes data we need this. </p>

</div>
</div>
<a id="af13e59b4c5f832286020da795b819e11"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af13e59b4c5f832286020da795b819e11">&#9670;&nbsp;</a></span>end_year</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int _icaltimezone::end_year</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This is the last year for which we have expanded the data to. If we need to calculate a date past this we need to expand the timezone component data from scratch. </p>

</div>
</div>
<a id="a90fc30929090b330fe1419602a0d7528"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a90fc30929090b330fe1419602a0d7528">&#9670;&nbsp;</a></span>location</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char* _icaltimezone::location</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The location for the timezone, e.g. "Africa/Accra" for the Olson database. We look for this in the "LOCATION" or "X-LIC-LOCATION" properties of the VTIMEZONE component. It isn't a standard property yet. This will be NULL if no location is found in the VTIMEZONE. </p>

</div>
</div>
<a id="a36ccaf1d81c7ec0463ed9ccf3eead700"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a36ccaf1d81c7ec0463ed9ccf3eead700">&#9670;&nbsp;</a></span>longitude</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double _icaltimezone::longitude</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The coordinates of the city, in degrees. </p>

</div>
</div>
<a id="ac863b840b171d996da68da6bfa664f89"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac863b840b171d996da68da6bfa664f89">&#9670;&nbsp;</a></span>tzid</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char* _icaltimezone::tzid</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The unique ID of this timezone, e.g. "/citadel.org/Olson_20010601_1/Africa/Banjul". This should only be used to identify a VTIMEZONE. It is not meant to be displayed to the user in any form. </p>

</div>
</div>
<a id="a7f30b657860b6bc98bdfd616c64eb20c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7f30b657860b6bc98bdfd616c64eb20c">&#9670;&nbsp;</a></span>tznames</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char* _icaltimezone::tznames</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>This will be set to a combination of the TZNAME properties from the last STANDARD and DAYLIGHT components in the VTIMEZONE, e.g. "EST/EDT". If they both use the same TZNAME, or only one type of component is found, then only one TZNAME will appear, e.g. "AZOT". If no TZNAME is found this will be NULL. </p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="icaltimezoneimpl_8h_source.html">icaltimezoneimpl.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Oct 6 2022 14:47:01 for Libical API Documentation by&#160;<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>