diff options
Diffstat (limited to 'apidocs/icaltimezone_8h.html')
| -rw-r--r-- | apidocs/icaltimezone_8h.html | 329 |
1 files changed, 78 insertions, 251 deletions
diff --git a/apidocs/icaltimezone_8h.html b/apidocs/icaltimezone_8h.html index a9a59df5..1910589f 100644 --- a/apidocs/icaltimezone_8h.html +++ b/apidocs/icaltimezone_8h.html @@ -3,7 +3,7 @@ <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.15"/> +<meta name="generator" content="Doxygen 1.8.18"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>Libical API Documentation: icaltimezone.h File Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> @@ -30,7 +30,7 @@ </table> </div> <!-- end header part --> -<!-- Generated by Doxygen 1.8.15 --> +<!-- Generated by Doxygen 1.8.18 --> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ var searchBox = new SearchBox("searchBox", "search",false,'Search'); @@ -75,7 +75,7 @@ $(function() { </div><!--header--> <div class="contents"> -<p>timezone handling routines +<p>Timezone handling routines. <a href="#details">More...</a></p> <p><a href="icaltimezone_8h_source.html">Go to the source code of this file.</a></p> @@ -100,57 +100,84 @@ void </td><td class="memItemRight" valign="bottom"><b>icaltimezone_array_fr <tr class="memitem:a9bfe00a48ea2014976c31c39f079f0d7"><td class="memItemLeft" align="right" valign="top"><a id="a9bfe00a48ea2014976c31c39f079f0d7"></a> <a class="el" href="icalarray_8h.html#ad36143942d5ac4709b68fff41615e598">icalarray</a> * </td><td class="memItemRight" valign="bottom"><b>icaltimezone_array_new</b> (void)</td></tr> <tr class="separator:a9bfe00a48ea2014976c31c39f079f0d7"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ad2d1ee1c58825d3308713fc71387fda8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#ad2d1ee1c58825d3308713fc71387fda8">icaltimezone_convert_time</a> (struct <a class="el" href="structicaltimetype.html">icaltimetype</a> *tt, <a class="el" href="struct__icaltimezone.html">icaltimezone</a> *from_zone, <a class="el" href="struct__icaltimezone.html">icaltimezone</a> *to_zone)</td></tr> +<tr class="memitem:ad2d1ee1c58825d3308713fc71387fda8"><td class="memItemLeft" align="right" valign="top"><a id="ad2d1ee1c58825d3308713fc71387fda8"></a> +void </td><td class="memItemRight" valign="bottom"><b>icaltimezone_convert_time</b> (struct <a class="el" href="structicaltimetype.html">icaltimetype</a> *tt, <a class="el" href="struct__icaltimezone.html">icaltimezone</a> *from_zone, <a class="el" href="struct__icaltimezone.html">icaltimezone</a> *to_zone)</td></tr> <tr class="separator:ad2d1ee1c58825d3308713fc71387fda8"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:afc822de0fdb9f92367a7b8fc0f55699a"><td class="memItemLeft" align="right" valign="top"><a id="afc822de0fdb9f92367a7b8fc0f55699a"></a> <a class="el" href="struct__icaltimezone.html">icaltimezone</a> * </td><td class="memItemRight" valign="bottom"><b>icaltimezone_copy</b> (<a class="el" href="struct__icaltimezone.html">icaltimezone</a> *originalzone)</td></tr> <tr class="separator:afc822de0fdb9f92367a7b8fc0f55699a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a12c7192c39744d49e4c23249926ae22a"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#a12c7192c39744d49e4c23249926ae22a">icaltimezone_dump_changes</a> (<a class="el" href="struct__icaltimezone.html">icaltimezone</a> *zone, int max_year, FILE *fp)</td></tr> +<tr class="memdesc:a12c7192c39744d49e4c23249926ae22a"><td class="mdescLeft"> </td><td class="mdescRight">Outputs a list of timezone changes for the given timezone to the given file, up to the maximum year given. <a href="icaltimezone_8h.html#a12c7192c39744d49e4c23249926ae22a">More...</a><br /></td></tr> <tr class="separator:a12c7192c39744d49e4c23249926ae22a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a56289e228ebd731806c73eb6dfcf57b0"><td class="memItemLeft" align="right" valign="top"><a id="a56289e228ebd731806c73eb6dfcf57b0"></a> void </td><td class="memItemRight" valign="bottom"><b>icaltimezone_expand_vtimezone</b> (<a class="el" href="structicalcomponent__impl.html">icalcomponent</a> *comp, int end_year, <a class="el" href="icalarray_8h.html#ad36143942d5ac4709b68fff41615e598">icalarray</a> *changes)</td></tr> <tr class="separator:a56289e228ebd731806c73eb6dfcf57b0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa96c3397fd8bcce74e1f220ca3fc333d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#aa96c3397fd8bcce74e1f220ca3fc333d">icaltimezone_free</a> (<a class="el" href="struct__icaltimezone.html">icaltimezone</a> *zone, int free_struct)</td></tr> +<tr class="memdesc:aa96c3397fd8bcce74e1f220ca3fc333d"><td class="mdescLeft"> </td><td class="mdescRight">Frees all memory used for the icaltimezone. <a href="icaltimezone_8h.html#aa96c3397fd8bcce74e1f220ca3fc333d">More...</a><br /></td></tr> <tr class="separator:aa96c3397fd8bcce74e1f220ca3fc333d"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a7596677c1f0c38bac7e687f37e19e397"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#a7596677c1f0c38bac7e687f37e19e397">icaltimezone_free_builtin_timezones</a> (void)</td></tr> +<tr class="memitem:a7596677c1f0c38bac7e687f37e19e397"><td class="memItemLeft" align="right" valign="top"><a id="a7596677c1f0c38bac7e687f37e19e397"></a> +void </td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#a7596677c1f0c38bac7e687f37e19e397">icaltimezone_free_builtin_timezones</a> (void)</td></tr> +<tr class="memdesc:a7596677c1f0c38bac7e687f37e19e397"><td class="mdescLeft"> </td><td class="mdescRight">Releases builtin timezone memory. <br /></td></tr> <tr class="separator:a7596677c1f0c38bac7e687f37e19e397"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:acd59a944189a01a0f6544401a70f8262"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct__icaltimezone.html">icaltimezone</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#acd59a944189a01a0f6544401a70f8262">icaltimezone_get_builtin_timezone</a> (const char *location)</td></tr> +<tr class="memitem:acd59a944189a01a0f6544401a70f8262"><td class="memItemLeft" align="right" valign="top"><a id="acd59a944189a01a0f6544401a70f8262"></a> +<a class="el" href="struct__icaltimezone.html">icaltimezone</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#acd59a944189a01a0f6544401a70f8262">icaltimezone_get_builtin_timezone</a> (const char *location)</td></tr> +<tr class="memdesc:acd59a944189a01a0f6544401a70f8262"><td class="mdescLeft"> </td><td class="mdescRight">Returns a single builtin timezone, given its Olson city name. <br /></td></tr> <tr class="separator:acd59a944189a01a0f6544401a70f8262"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a7433cb4ebc6cb07579a1140261c6f555"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct__icaltimezone.html">icaltimezone</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#a7433cb4ebc6cb07579a1140261c6f555">icaltimezone_get_builtin_timezone_from_offset</a> (int offset, const char *tzname)</td></tr> +<tr class="memitem:a7433cb4ebc6cb07579a1140261c6f555"><td class="memItemLeft" align="right" valign="top"><a id="a7433cb4ebc6cb07579a1140261c6f555"></a> +<a class="el" href="struct__icaltimezone.html">icaltimezone</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#a7433cb4ebc6cb07579a1140261c6f555">icaltimezone_get_builtin_timezone_from_offset</a> (int offset, const char *tzname)</td></tr> +<tr class="memdesc:a7433cb4ebc6cb07579a1140261c6f555"><td class="mdescLeft"> </td><td class="mdescRight">Returns a single builtin timezone, given its offset from UTC. <br /></td></tr> <tr class="separator:a7433cb4ebc6cb07579a1140261c6f555"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:af54e0abc7f5d934864f3c06c9beb59cd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct__icaltimezone.html">icaltimezone</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#af54e0abc7f5d934864f3c06c9beb59cd">icaltimezone_get_builtin_timezone_from_tzid</a> (const char *tzid)</td></tr> +<tr class="memitem:af54e0abc7f5d934864f3c06c9beb59cd"><td class="memItemLeft" align="right" valign="top"><a id="af54e0abc7f5d934864f3c06c9beb59cd"></a> +<a class="el" href="struct__icaltimezone.html">icaltimezone</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#af54e0abc7f5d934864f3c06c9beb59cd">icaltimezone_get_builtin_timezone_from_tzid</a> (const char *tzid)</td></tr> +<tr class="memdesc:af54e0abc7f5d934864f3c06c9beb59cd"><td class="mdescLeft"> </td><td class="mdescRight">Returns a single builtin timezone, given its TZID. <br /></td></tr> <tr class="separator:af54e0abc7f5d934864f3c06c9beb59cd"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:acad626a5835066667c38aac0894e798c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="icalarray_8h.html#ad36143942d5ac4709b68fff41615e598">icalarray</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#acad626a5835066667c38aac0894e798c">icaltimezone_get_builtin_timezones</a> (void)</td></tr> +<tr class="memdesc:acad626a5835066667c38aac0894e798c"><td class="mdescLeft"> </td><td class="mdescRight">Returns an icalarray of icaltimezone structs, one for each builtin timezone. <a href="icaltimezone_8h.html#acad626a5835066667c38aac0894e798c">More...</a><br /></td></tr> <tr class="separator:acad626a5835066667c38aac0894e798c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac61539c2df5b4f58a453ac3377d5ad6b"><td class="memItemLeft" align="right" valign="top"><a id="ac61539c2df5b4f58a453ac3377d5ad6b"></a> int </td><td class="memItemRight" valign="bottom"><b>icaltimezone_get_builtin_tzdata</b> (void)</td></tr> <tr class="separator:ac61539c2df5b4f58a453ac3377d5ad6b"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a096d18647de1113c19d2309a1f4c2931"><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="icaltimezone_8h.html#a096d18647de1113c19d2309a1f4c2931">icaltimezone_get_component</a> (<a class="el" href="struct__icaltimezone.html">icaltimezone</a> *zone)</td></tr> +<tr class="memitem:a096d18647de1113c19d2309a1f4c2931"><td class="memItemLeft" align="right" valign="top"><a id="a096d18647de1113c19d2309a1f4c2931"></a> +<a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#a096d18647de1113c19d2309a1f4c2931">icaltimezone_get_component</a> (<a class="el" href="struct__icaltimezone.html">icaltimezone</a> *zone)</td></tr> +<tr class="memdesc:a096d18647de1113c19d2309a1f4c2931"><td class="mdescLeft"> </td><td class="mdescRight">Returns the VTIMEZONE component of a timezone. <br /></td></tr> <tr class="separator:a096d18647de1113c19d2309a1f4c2931"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ac32053bf56b415c44d7527bc89318757"><td class="memItemLeft" align="right" valign="top"><a id="ac32053bf56b415c44d7527bc89318757"></a> -const char * </td><td class="memItemRight" valign="bottom"><b>icaltimezone_get_display_name</b> (<a class="el" href="struct__icaltimezone.html">icaltimezone</a> *zone)</td></tr> +<tr class="memitem:ac32053bf56b415c44d7527bc89318757"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#ac32053bf56b415c44d7527bc89318757">icaltimezone_get_display_name</a> (<a class="el" href="struct__icaltimezone.html">icaltimezone</a> *zone)</td></tr> +<tr class="memdesc:ac32053bf56b415c44d7527bc89318757"><td class="mdescLeft"> </td><td class="mdescRight">Returns the timezone name to display to the user. <a href="icaltimezone_8h.html#ac32053bf56b415c44d7527bc89318757">More...</a><br /></td></tr> <tr class="separator:ac32053bf56b415c44d7527bc89318757"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:acfc51cb64dcc62ff668df02073c803d6"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#acfc51cb64dcc62ff668df02073c803d6">icaltimezone_get_latitude</a> (<a class="el" href="struct__icaltimezone.html">icaltimezone</a> *zone)</td></tr> +<tr class="memitem:acfc51cb64dcc62ff668df02073c803d6"><td class="memItemLeft" align="right" valign="top"><a id="acfc51cb64dcc62ff668df02073c803d6"></a> +double </td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#acfc51cb64dcc62ff668df02073c803d6">icaltimezone_get_latitude</a> (<a class="el" href="struct__icaltimezone.html">icaltimezone</a> *zone)</td></tr> +<tr class="memdesc:acfc51cb64dcc62ff668df02073c803d6"><td class="mdescLeft"> </td><td class="mdescRight">Returns the latitude of a builtin timezone. <br /></td></tr> <tr class="separator:acfc51cb64dcc62ff668df02073c803d6"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac2fbe5451e417f7ec50f346bbde8247d"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#ac2fbe5451e417f7ec50f346bbde8247d">icaltimezone_get_location</a> (<a class="el" href="struct__icaltimezone.html">icaltimezone</a> *zone)</td></tr> <tr class="separator:ac2fbe5451e417f7ec50f346bbde8247d"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a41d1e5b940ebc05aaa2def6bcfccba37"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#a41d1e5b940ebc05aaa2def6bcfccba37">icaltimezone_get_location_from_vtimezone</a> (<a class="el" href="structicalcomponent__impl.html">icalcomponent</a> *component)</td></tr> +<tr class="memitem:a41d1e5b940ebc05aaa2def6bcfccba37"><td class="memItemLeft" align="right" valign="top"><a id="a41d1e5b940ebc05aaa2def6bcfccba37"></a> +char * </td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#a41d1e5b940ebc05aaa2def6bcfccba37">icaltimezone_get_location_from_vtimezone</a> (<a class="el" href="structicalcomponent__impl.html">icalcomponent</a> *component)</td></tr> +<tr class="memdesc:a41d1e5b940ebc05aaa2def6bcfccba37"><td class="mdescLeft"> </td><td class="mdescRight">Gets the LOCATION or X-LIC-LOCATION property from a VTIMEZONE. <br /></td></tr> <tr class="separator:a41d1e5b940ebc05aaa2def6bcfccba37"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a346caee2838d8dfbeb07bc9c66b04e2b"><td class="memItemLeft" align="right" valign="top">double </td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#a346caee2838d8dfbeb07bc9c66b04e2b">icaltimezone_get_longitude</a> (<a class="el" href="struct__icaltimezone.html">icaltimezone</a> *zone)</td></tr> +<tr class="memitem:a346caee2838d8dfbeb07bc9c66b04e2b"><td class="memItemLeft" align="right" valign="top"><a id="a346caee2838d8dfbeb07bc9c66b04e2b"></a> +double </td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#a346caee2838d8dfbeb07bc9c66b04e2b">icaltimezone_get_longitude</a> (<a class="el" href="struct__icaltimezone.html">icaltimezone</a> *zone)</td></tr> +<tr class="memdesc:a346caee2838d8dfbeb07bc9c66b04e2b"><td class="mdescLeft"> </td><td class="mdescRight">Returns the longitude of a builtin timezone. <br /></td></tr> <tr class="separator:a346caee2838d8dfbeb07bc9c66b04e2b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1f2ba5baf0d556ab8ea8f5eb81e5af29"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#a1f2ba5baf0d556ab8ea8f5eb81e5af29">icaltimezone_get_tzid</a> (<a class="el" href="struct__icaltimezone.html">icaltimezone</a> *zone)</td></tr> <tr class="separator:a1f2ba5baf0d556ab8ea8f5eb81e5af29"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab7448438384fd57d93edf5e3ea632c90"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#ab7448438384fd57d93edf5e3ea632c90">icaltimezone_get_tznames</a> (<a class="el" href="struct__icaltimezone.html">icaltimezone</a> *zone)</td></tr> <tr class="separator:ab7448438384fd57d93edf5e3ea632c90"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:abc43a04d4d4a0b3229d28dde2e92835b"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#abc43a04d4d4a0b3229d28dde2e92835b">icaltimezone_get_tznames_from_vtimezone</a> (<a class="el" href="structicalcomponent__impl.html">icalcomponent</a> *component)</td></tr> +<tr class="memdesc:abc43a04d4d4a0b3229d28dde2e92835b"><td class="mdescLeft"> </td><td class="mdescRight">Gets the TZNAMEs used for the last STANDARD & DAYLIGHT components in a VTIMEZONE. <a href="icaltimezone_8h.html#abc43a04d4d4a0b3229d28dde2e92835b">More...</a><br /></td></tr> <tr class="separator:abc43a04d4d4a0b3229d28dde2e92835b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1ebe99e4975a461da82f4add92ca01d4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#a1ebe99e4975a461da82f4add92ca01d4">icaltimezone_get_utc_offset</a> (<a class="el" href="struct__icaltimezone.html">icaltimezone</a> *zone, struct <a class="el" href="structicaltimetype.html">icaltimetype</a> *tt, int *is_daylight)</td></tr> +<tr class="memdesc:a1ebe99e4975a461da82f4add92ca01d4"><td class="mdescLeft"> </td><td class="mdescRight">Calculates the UTC offset of a given local time in the given timezone. <a href="icaltimezone_8h.html#a1ebe99e4975a461da82f4add92ca01d4">More...</a><br /></td></tr> <tr class="separator:a1ebe99e4975a461da82f4add92ca01d4"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:af6c4b7dc1e0c056bfbbd0f833d039b5d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#af6c4b7dc1e0c056bfbbd0f833d039b5d">icaltimezone_get_utc_offset_of_utc_time</a> (<a class="el" href="struct__icaltimezone.html">icaltimezone</a> *zone, struct <a class="el" href="structicaltimetype.html">icaltimetype</a> *tt, int *is_daylight)</td></tr> +<tr class="memdesc:af6c4b7dc1e0c056bfbbd0f833d039b5d"><td class="mdescLeft"> </td><td class="mdescRight">Calculates the UTC offset of a given UTC time in the given timezone. <a href="icaltimezone_8h.html#af6c4b7dc1e0c056bfbbd0f833d039b5d">More...</a><br /></td></tr> <tr class="separator:af6c4b7dc1e0c056bfbbd0f833d039b5d"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:a993ceafd420a2c46651db1503d1adc9a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct__icaltimezone.html">icaltimezone</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#a993ceafd420a2c46651db1503d1adc9a">icaltimezone_get_utc_timezone</a> (void)</td></tr> +<tr class="memitem:a993ceafd420a2c46651db1503d1adc9a"><td class="memItemLeft" align="right" valign="top"><a id="a993ceafd420a2c46651db1503d1adc9a"></a> +<a class="el" href="struct__icaltimezone.html">icaltimezone</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#a993ceafd420a2c46651db1503d1adc9a">icaltimezone_get_utc_timezone</a> (void)</td></tr> +<tr class="memdesc:a993ceafd420a2c46651db1503d1adc9a"><td class="mdescLeft"> </td><td class="mdescRight">Returns the UTC timezone. <br /></td></tr> <tr class="separator:a993ceafd420a2c46651db1503d1adc9a"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ac3a8d8fa9901d42ab989f1a1e746956c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct__icaltimezone.html">icaltimezone</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#ac3a8d8fa9901d42ab989f1a1e746956c">icaltimezone_new</a> (void)</td></tr> +<tr class="memitem:ac3a8d8fa9901d42ab989f1a1e746956c"><td class="memItemLeft" align="right" valign="top"><a id="ac3a8d8fa9901d42ab989f1a1e746956c"></a> +<a class="el" href="struct__icaltimezone.html">icaltimezone</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#ac3a8d8fa9901d42ab989f1a1e746956c">icaltimezone_new</a> (void)</td></tr> +<tr class="memdesc:ac3a8d8fa9901d42ab989f1a1e746956c"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new icaltimezone. <br /></td></tr> <tr class="separator:ac3a8d8fa9901d42ab989f1a1e746956c"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ab04e61bc742f6fb07472b682d838822c"><td class="memItemLeft" align="right" valign="top"><a id="ab04e61bc742f6fb07472b682d838822c"></a> void </td><td class="memItemRight" valign="bottom"><b>icaltimezone_release_zone_tab</b> (void)</td></tr> @@ -159,6 +186,7 @@ void </td><td class="memItemRight" valign="bottom"><b>icaltimezone_release_ void </td><td class="memItemRight" valign="bottom"><b>icaltimezone_set_builtin_tzdata</b> (int set)</td></tr> <tr class="separator:a74df462127727a146144d1eb80067c72"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac06a9a060f021b7f4bdff282b2638357"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#ac06a9a060f021b7f4bdff282b2638357">icaltimezone_set_component</a> (<a class="el" href="struct__icaltimezone.html">icaltimezone</a> *zone, <a class="el" href="structicalcomponent__impl.html">icalcomponent</a> *comp)</td></tr> +<tr class="memdesc:ac06a9a060f021b7f4bdff282b2638357"><td class="mdescLeft"> </td><td class="mdescRight">Sets the VTIMEZONE component of an icaltimezone, initializing the tzid, location & tzname fields. <a href="icaltimezone_8h.html#ac06a9a060f021b7f4bdff282b2638357">More...</a><br /></td></tr> <tr class="separator:ac06a9a060f021b7f4bdff282b2638357"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a04849ce67c1a529f19d695b74cb238fe"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="icaltimezone_8h.html#a04849ce67c1a529f19d695b74cb238fe">icaltimezone_set_tzid_prefix</a> (const char *new_prefix)</td></tr> <tr class="separator:a04849ce67c1a529f19d695b74cb238fe"><td class="memSeparator" colspan="2"> </td></tr> @@ -172,7 +200,7 @@ const char * </td><td class="memItemRight" valign="bottom"><b>icaltimezone_ <tr class="separator:af35f72898e3992529e12c07c62659b22"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> -<div class="textblock"><p>timezone handling routines </p> +<div class="textblock"><p>Timezone handling routines. </p> </div><h2 class="groupheader">Function Documentation</h2> <a id="a431f7b425ec073cdd490431d4285f294"></a> <h2 class="memtitle"><span class="permalink"><a href="#a431f7b425ec073cdd490431d4285f294">◆ </a></span>free_zone_directory()</h2> @@ -189,42 +217,7 @@ const char * </td><td class="memItemRight" valign="bottom"><b>icaltimezone_ </tr> </table> </div><div class="memdoc"> -<p>Free memory dedicated to the zonefile directory </p> - -</div> -</div> -<a id="ad2d1ee1c58825d3308713fc71387fda8"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ad2d1ee1c58825d3308713fc71387fda8">◆ </a></span>icaltimezone_convert_time()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void icaltimezone_convert_time </td> - <td>(</td> - <td class="paramtype">struct <a class="el" href="structicaltimetype.html">icaltimetype</a> * </td> - <td class="paramname"><em>tt</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype"><a class="el" href="struct__icaltimezone.html">icaltimezone</a> * </td> - <td class="paramname"><em>from_zone</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype"><a class="el" href="struct__icaltimezone.html">icaltimezone</a> * </td> - <td class="paramname"><em>to_zone</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<dl class="section user"><dt>Converting times between timezones.</dt><dd></dd></dl> +<p>Frees the memory dedicated to the zonefile directory </p> </div> </div> @@ -259,8 +252,9 @@ const char * </td><td class="memItemRight" valign="bottom"><b>icaltimezone_ </tr> </table> </div><div class="memdoc"> -<p>Dumps information about changes in the timezone up to and including max_year.</p> -<p>This outputs a list of timezone changes for the given timezone to the given file, up to the maximum year given. We compare this output with the output from 'vzic –dump-changes' to make sure that we are consistent. (vzic is the Olson timezone database to VTIMEZONE converter.)</p> + +<p>Outputs a list of timezone changes for the given timezone to the given file, up to the maximum year given. </p> +<p>We compare this output with the output from 'vzic –dump-changes' to make sure that we are consistent. (vzic is the Olson timezone database to VTIMEZONE converter.)</p> <p>The output format is: </p><pre class="fragment"> Zone-Name [tab] Date [tab] Time [tab] UTC-Offset </pre><p>The Date and Time fields specify the time change in UTC.</p> <p>The UTC Offset is for local (wall-clock) time. It is the amount of time to add to UTC to get local time. </p> @@ -292,96 +286,15 @@ const char * </td><td class="memItemRight" valign="bottom"><b>icaltimezone_ </tr> </table> </div><div class="memdoc"> -<p>Frees all memory used for the icaltimezone. Set free_struct to free the icaltimezone struct as well.</p> -<p>Frees all memory used for the icaltimezone. </p> - -</div> -</div> -<a id="a7596677c1f0c38bac7e687f37e19e397"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a7596677c1f0c38bac7e687f37e19e397">◆ </a></span>icaltimezone_free_builtin_timezones()</h2> -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">void icaltimezone_free_builtin_timezones </td> - <td>(</td> - <td class="paramtype">void </td> - <td class="paramname"></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<dl class="section user"><dt>Accessing timezones.Free any builtin timezone information </dt><dd></dd></dl> -<p>Release builtin timezone memory </p> - -</div> -</div> -<a id="acd59a944189a01a0f6544401a70f8262"></a> -<h2 class="memtitle"><span class="permalink"><a href="#acd59a944189a01a0f6544401a70f8262">◆ </a></span>icaltimezone_get_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_get_builtin_timezone </td> - <td>(</td> - <td class="paramtype">const char * </td> - <td class="paramname"><em>location</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Returns a single builtin timezone, given its Olson city name. </p> - -</div> -</div> -<a id="a7433cb4ebc6cb07579a1140261c6f555"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a7433cb4ebc6cb07579a1140261c6f555">◆ </a></span>icaltimezone_get_builtin_timezone_from_offset()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="struct__icaltimezone.html">icaltimezone</a>* icaltimezone_get_builtin_timezone_from_offset </td> - <td>(</td> - <td class="paramtype">int </td> - <td class="paramname"><em>offset</em>, </td> - </tr> - <tr> - <td class="paramkey"></td> - <td></td> - <td class="paramtype">const char * </td> - <td class="paramname"><em>tzname</em> </td> - </tr> - <tr> - <td></td> - <td>)</td> - <td></td><td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Returns a single builtin timezone, given its offset.</p> -<p>Returns a single builtin timezone, given its offset from UTC </p> - -</div> -</div> -<a id="af54e0abc7f5d934864f3c06c9beb59cd"></a> -<h2 class="memtitle"><span class="permalink"><a href="#af54e0abc7f5d934864f3c06c9beb59cd">◆ </a></span>icaltimezone_get_builtin_timezone_from_tzid()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="struct__icaltimezone.html">icaltimezone</a>* icaltimezone_get_builtin_timezone_from_tzid </td> - <td>(</td> - <td class="paramtype">const char * </td> - <td class="paramname"><em>tzid</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Returns a single builtin timezone, given its TZID. </p> +<p>Frees all memory used for the icaltimezone. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">zone</td><td>The icaltimezone to be freed </td></tr> + <tr><td class="paramname">free_struct</td><td>Whether to free the icaltimezone struct as well </td></tr> + </table> + </dd> +</dl> </div> </div> @@ -400,38 +313,20 @@ const char * </td><td class="memItemRight" valign="bottom"><b>icaltimezone_ </tr> </table> </div><div class="memdoc"> -<p>Returns the array of builtin icaltimezones.</p> -<p>Returns an icalarray of icaltimezone structs, one for each builtin timezone. This will load and parse the zones.tab file to get the timezone names and their coordinates. It will not load the VTIMEZONE data for any timezones. </p> - -</div> -</div> -<a id="a096d18647de1113c19d2309a1f4c2931"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a096d18647de1113c19d2309a1f4c2931">◆ </a></span>icaltimezone_get_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_get_component </td> - <td>(</td> - <td class="paramtype"><a class="el" href="struct__icaltimezone.html">icaltimezone</a> * </td> - <td class="paramname"><em>zone</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Returns the VTIMEZONE component of a timezone. </p> +<p>Returns an icalarray of icaltimezone structs, one for each builtin timezone. </p> +<p>This will load and parse the zones.tab file to get the timezone names and their coordinates. It will not load the VTIMEZONE data for any timezones. </p> </div> </div> -<a id="acfc51cb64dcc62ff668df02073c803d6"></a> -<h2 class="memtitle"><span class="permalink"><a href="#acfc51cb64dcc62ff668df02073c803d6">◆ </a></span>icaltimezone_get_latitude()</h2> +<a id="ac32053bf56b415c44d7527bc89318757"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ac32053bf56b415c44d7527bc89318757">◆ </a></span>icaltimezone_get_display_name()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">double icaltimezone_get_latitude </td> + <td class="memname">const char* icaltimezone_get_display_name </td> <td>(</td> <td class="paramtype"><a class="el" href="struct__icaltimezone.html">icaltimezone</a> * </td> <td class="paramname"><em>zone</em></td><td>)</td> @@ -439,7 +334,9 @@ const char * </td><td class="memItemRight" valign="bottom"><b>icaltimezone_ </tr> </table> </div><div class="memdoc"> -<p>Returns the latitude of a builtin timezone. </p> + +<p>Returns the timezone name to display to the user. </p> +<p>We prefer to use the Olson city name, but fall back on the TZNAME, or finally the TZID. We don't want to use "" as it may be wrongly interpreted as a floating time. Do not free the returned string. </p> </div> </div> @@ -462,44 +359,6 @@ const char * </td><td class="memItemRight" valign="bottom"><b>icaltimezone_ </div> </div> -<a id="a41d1e5b940ebc05aaa2def6bcfccba37"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a41d1e5b940ebc05aaa2def6bcfccba37">◆ </a></span>icaltimezone_get_location_from_vtimezone()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">char* icaltimezone_get_location_from_vtimezone </td> - <td>(</td> - <td class="paramtype"><a class="el" href="structicalcomponent__impl.html">icalcomponent</a> * </td> - <td class="paramname"><em>component</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Gets the LOCATION or X-LIC-LOCATION property from a VTIMEZONE. </p> - -</div> -</div> -<a id="a346caee2838d8dfbeb07bc9c66b04e2b"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a346caee2838d8dfbeb07bc9c66b04e2b">◆ </a></span>icaltimezone_get_longitude()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname">double icaltimezone_get_longitude </td> - <td>(</td> - <td class="paramtype"><a class="el" href="struct__icaltimezone.html">icaltimezone</a> * </td> - <td class="paramname"><em>zone</em></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Returns the longitude of a builtin timezone. </p> - -</div> -</div> <a id="a1f2ba5baf0d556ab8ea8f5eb81e5af29"></a> <h2 class="memtitle"><span class="permalink"><a href="#a1f2ba5baf0d556ab8ea8f5eb81e5af29">◆ </a></span>icaltimezone_get_tzid()</h2> @@ -553,7 +412,9 @@ const char * </td><td class="memItemRight" valign="bottom"><b>icaltimezone_ </tr> </table> </div><div class="memdoc"> -<p>Gets the TZNAMEs used for the last STANDARD & DAYLIGHT components in a VTIMEZONE. If both STANDARD and DAYLIGHT components use the same TZNAME, it returns that. If they use different TZNAMEs, it formats them like "EST/EDT". The returned string should be freed by the caller. </p> + +<p>Gets the TZNAMEs used for the last STANDARD & DAYLIGHT components in a VTIMEZONE. </p> +<p>If both STANDARD and DAYLIGHT components use the same TZNAME, it returns that. If they use different TZNAMEs, it formats them like "EST/EDT". The returned string should be freed by the caller. </p> </div> </div> @@ -588,7 +449,9 @@ const char * </td><td class="memItemRight" valign="bottom"><b>icaltimezone_ </tr> </table> </div><div class="memdoc"> -<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 local time in the given timezone. </p> +<p>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> </div> </div> @@ -623,47 +486,9 @@ const char * </td><td class="memItemRight" valign="bottom"><b>icaltimezone_ </tr> </table> </div><div class="memdoc"> -<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> -</div> -</div> -<a id="a993ceafd420a2c46651db1503d1adc9a"></a> -<h2 class="memtitle"><span class="permalink"><a href="#a993ceafd420a2c46651db1503d1adc9a">◆ </a></span>icaltimezone_get_utc_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_get_utc_timezone </td> - <td>(</td> - <td class="paramtype">void </td> - <td class="paramname"></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<p>Returns the UTC timezone.</p> -<p>Returns the special UTC timezone. </p> - -</div> -</div> -<a id="ac3a8d8fa9901d42ab989f1a1e746956c"></a> -<h2 class="memtitle"><span class="permalink"><a href="#ac3a8d8fa9901d42ab989f1a1e746956c">◆ </a></span>icaltimezone_new()</h2> - -<div class="memitem"> -<div class="memproto"> - <table class="memname"> - <tr> - <td class="memname"><a class="el" href="struct__icaltimezone.html">icaltimezone</a>* icaltimezone_new </td> - <td>(</td> - <td class="paramtype">void </td> - <td class="paramname"></td><td>)</td> - <td></td> - </tr> - </table> -</div><div class="memdoc"> -<dl class="section user"><dt>Creating/Destroying individual icaltimezones.Creates a new icaltimezone. </dt><dd></dd></dl> -<p>Creates a new icaltimezone. </p> +<p>Calculates the UTC offset of a given UTC time in the given timezone. </p> +<p>It is the number of seconds to add to UTC to get local time. The <code>is_daylight</code> flag is set to 1 if the time is in daylight-savings time. </p> </div> </div> @@ -692,7 +517,9 @@ const char * </td><td class="memItemRight" valign="bottom"><b>icaltimezone_ </tr> </table> </div><div class="memdoc"> -<p>Sets the VTIMEZONE component of an icaltimezone, initializing the tzid, location & tzname fields. It returns 1 on success or 0 on failure, i.e. no TZID was found. </p> + +<p>Sets the VTIMEZONE component of an icaltimezone, initializing the tzid, location & tzname fields. </p> +<dl class="section return"><dt>Returns</dt><dd>1 on success or 0 on failure, i.e. no TZID was found. </dd></dl> </div> </div> @@ -730,7 +557,7 @@ const char * </td><td class="memItemRight" valign="bottom"><b>icaltimezone_ </tr> </table> </div><div class="memdoc"> -<p>Set the directory to look for the zonefiles </p> +<p>Sets the directory to look for the zonefiles </p> </div> </div> @@ -739,7 +566,7 @@ const char * </td><td class="memItemRight" valign="bottom"><b>icaltimezone_ <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.15 +</a> 1.8.18 </small></address> </body> </html> |