/usr/share/gtk-doc/html/eds/eds-e-time-utils.html is in evolution-data-server-doc 3.22.7-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>e-time-utils: Evolution-Data-Server Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Evolution-Data-Server Reference Manual">
<link rel="up" href="ch10.html" title="Available for clients and backends">
<link rel="prev" href="eds-e-soup-ssl-trust.html" title="e-soup-ssl-trust">
<link rel="next" href="eds-e-uid.html" title="e-uid">
<meta name="generator" content="GTK-Doc V1.25 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#eds-e-time-utils.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch10.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="eds-e-soup-ssl-trust.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="eds-e-uid.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="eds-e-time-utils"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="eds-e-time-utils.top_of_page"></a>e-time-utils</span></h2>
<p>e-time-utils</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="eds-e-time-utils.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="eds-e-time-utils.html#ETimeParseStatus" title="enum ETimeParseStatus"><span class="returnvalue">ETimeParseStatus</span></a>
</td>
<td class="function_name">
<a class="link" href="eds-e-time-utils.html#e-time-parse-date-and-time" title="e_time_parse_date_and_time ()">e_time_parse_date_and_time</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="eds-e-time-utils.html#ETimeParseStatus" title="enum ETimeParseStatus"><span class="returnvalue">ETimeParseStatus</span></a>
</td>
<td class="function_name">
<a class="link" href="eds-e-time-utils.html#e-time-parse-date" title="e_time_parse_date ()">e_time_parse_date</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="eds-e-time-utils.html#ETimeParseStatus" title="enum ETimeParseStatus"><span class="returnvalue">ETimeParseStatus</span></a>
</td>
<td class="function_name">
<a class="link" href="eds-e-time-utils.html#e-time-parse-date-and-time-ex" title="e_time_parse_date_and_time_ex ()">e_time_parse_date_and_time_ex</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="eds-e-time-utils.html#ETimeParseStatus" title="enum ETimeParseStatus"><span class="returnvalue">ETimeParseStatus</span></a>
</td>
<td class="function_name">
<a class="link" href="eds-e-time-utils.html#e-time-parse-date-ex" title="e_time_parse_date_ex ()">e_time_parse_date_ex</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="eds-e-time-utils.html#ETimeParseStatus" title="enum ETimeParseStatus"><span class="returnvalue">ETimeParseStatus</span></a>
</td>
<td class="function_name">
<a class="link" href="eds-e-time-utils.html#e-time-parse-time" title="e_time_parse_time ()">e_time_parse_time</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="eds-e-time-utils.html#e-time-format-date-and-time" title="e_time_format_date_and_time ()">e_time_format_date_and_time</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="eds-e-time-utils.html#e-time-format-time" title="e_time_format_time ()">e_time_format_time</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">time_t</span>
</td>
<td class="function_name">
<a class="link" href="eds-e-time-utils.html#e-mktime-utc" title="e_mktime_utc ()">e_mktime_utc</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="eds-e-time-utils.html#e-localtime-with-offset" title="e_localtime_with_offset ()">e_localtime_with_offset</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="eds-e-time-utils.html#e-time-get-d-fmt-with-4digit-year" title="e_time_get_d_fmt_with_4digit_year ()">e_time_get_d_fmt_with_4digit_year</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="eds-e-time-utils.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">enum</td>
<td class="function_name"><a class="link" href="eds-e-time-utils.html#ETimeParseStatus" title="enum ETimeParseStatus">ETimeParseStatus</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="eds-e-time-utils.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="eds-e-time-utils.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="e-time-parse-date-and-time"></a><h3>e_time_parse_date_and_time ()</h3>
<pre class="programlisting"><a class="link" href="eds-e-time-utils.html#ETimeParseStatus" title="enum ETimeParseStatus"><span class="returnvalue">ETimeParseStatus</span></a>
e_time_parse_date_and_time (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *value</code></em>,
<em class="parameter"><code><span class="type">struct tm</span> *result</code></em>);</pre>
<p>Parses a string <em class="parameter"><code>value</code></em>
containing a date and a time and stores the
result in <em class="parameter"><code>result</code></em>
. The date in <em class="parameter"><code>value</code></em>
is expected to be in a format
like "Wed 3/13/00 14:20:00", though <code class="function">gettext()</code> is used to support the
appropriate local formats. There is also some leniency on the
format of the string, e.g. the weekday can be skipped or 12-hour
formats with am/pm can be used.</p>
<div class="refsect3">
<a name="e-time-parse-date-and-time.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p>the string to parse a date and time from</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>result</p></td>
<td class="parameter_description"><p>a <a class="link" href="eds-e-data-server-util.html#tm" title="struct tm"><span class="type">tm</span></a> to store the result in</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-time-parse-date-and-time.returns"></a><h4>Returns</h4>
<p> E_TIME_PARSE_OK if the string was successfully parsed,
E_TIME_PARSE_NONE if the string was empty, or
E_TIME_PARSE_INVALID if the string could not be parsed.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-time-parse-date"></a><h3>e_time_parse_date ()</h3>
<pre class="programlisting"><a class="link" href="eds-e-time-utils.html#ETimeParseStatus" title="enum ETimeParseStatus"><span class="returnvalue">ETimeParseStatus</span></a>
e_time_parse_date (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *value</code></em>,
<em class="parameter"><code><span class="type">struct tm</span> *result</code></em>);</pre>
<p>Takes in a date string entered by the user and tries to convert it to
a struct <a class="link" href="eds-e-data-server-util.html#tm" title="struct tm"><span class="type">tm</span></a>.</p>
<div class="refsect3">
<a name="e-time-parse-date.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p>A date string.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>result</p></td>
<td class="parameter_description"><p>Return value for the parsed date.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-time-parse-date.returns"></a><h4>Returns</h4>
<p> An <a class="link" href="eds-e-time-utils.html#ETimeParseStatus" title="enum ETimeParseStatus"><span class="type">ETimeParseStatus</span></a> result code indicating whether
<em class="parameter"><code>value</code></em>
was an empty string, a valid date, or an invalid date.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-time-parse-date-and-time-ex"></a><h3>e_time_parse_date_and_time_ex ()</h3>
<pre class="programlisting"><a class="link" href="eds-e-time-utils.html#ETimeParseStatus" title="enum ETimeParseStatus"><span class="returnvalue">ETimeParseStatus</span></a>
e_time_parse_date_and_time_ex (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *value</code></em>,
<em class="parameter"><code><span class="type">struct tm</span> *result</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *two_digit_year</code></em>);</pre>
<p>Parses a string <em class="parameter"><code>value</code></em>
containing a date and a time and stores the
result in <em class="parameter"><code>result</code></em>
. The date in <em class="parameter"><code>value</code></em>
is expected to be in a format
like "Wed 3/13/00 14:20:00", though <code class="function">gettext()</code> is used to support the
appropriate local formats. There is also some leniency on the
format of the string, e.g. the weekday can be skipped or 12-hour
formats with am/pm can be used.</p>
<div class="refsect3">
<a name="e-time-parse-date-and-time-ex.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p>The string to parse a date and time from.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>result</p></td>
<td class="parameter_description"><p>A <a class="link" href="eds-e-data-server-util.html#tm" title="struct tm"><span class="type">tm</span></a> to store the result in.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>two_digit_year</p></td>
<td class="parameter_description"><p>set to TRUE, is parsing with two-digit year, else FALSE,
but only when not NULL.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-time-parse-date-and-time-ex.returns"></a><h4>Returns</h4>
<p> E_TIME_PARSE_OK if the string was successfully parsed,
E_TIME_PARSE_NONE if the string was empty, or
E_TIME_PARSE_INVALID if the string could not be parsed.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2.22.html" title="Index of new symbols in 2.22">2.22</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-time-parse-date-ex"></a><h3>e_time_parse_date_ex ()</h3>
<pre class="programlisting"><a class="link" href="eds-e-time-utils.html#ETimeParseStatus" title="enum ETimeParseStatus"><span class="returnvalue">ETimeParseStatus</span></a>
e_time_parse_date_ex (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *value</code></em>,
<em class="parameter"><code><span class="type">struct tm</span> *result</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> *two_digit_year</code></em>);</pre>
<p>Takes in a date string entered by the user and tries to convert it to
a struct <a class="link" href="eds-e-data-server-util.html#tm" title="struct tm"><span class="type">tm</span></a>.</p>
<div class="refsect3">
<a name="e-time-parse-date-ex.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p>A date string.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>result</p></td>
<td class="parameter_description"><p>Return value for the parsed date.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>two_digit_year</p></td>
<td class="parameter_description"><p>set to TRUE, is parsing with two-digit year, else FALSE,
but only when not NULL.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-time-parse-date-ex.returns"></a><h4>Returns</h4>
<p> An <a class="link" href="eds-e-time-utils.html#ETimeParseStatus" title="enum ETimeParseStatus"><span class="type">ETimeParseStatus</span></a> result code indicating whether
<em class="parameter"><code>value</code></em>
was an empty string, a valid date, or an invalid date.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2.22.html" title="Index of new symbols in 2.22">2.22</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-time-parse-time"></a><h3>e_time_parse_time ()</h3>
<pre class="programlisting"><a class="link" href="eds-e-time-utils.html#ETimeParseStatus" title="enum ETimeParseStatus"><span class="returnvalue">ETimeParseStatus</span></a>
e_time_parse_time (<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *value</code></em>,
<em class="parameter"><code><span class="type">struct tm</span> *result</code></em>);</pre>
<p>Parses <em class="parameter"><code>value</code></em>
, a string containing a time. <em class="parameter"><code>value</code></em>
is expected to be
in a format like "14:20:00". <code class="function">gettext()</code> is used to
support the appropriate local formats and slightly
different formats, such as 12-hour formats with am/pm,
are accepted as well.</p>
<div class="refsect3">
<a name="e-time-parse-time.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>value</p></td>
<td class="parameter_description"><p>The string to parse a time from.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>result</p></td>
<td class="parameter_description"><p>A <a class="link" href="eds-e-data-server-util.html#tm" title="struct tm"><span class="type">tm</span></a> to store the result in.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-time-parse-time.returns"></a><h4>Returns</h4>
<p> An <a class="link" href="eds-e-time-utils.html#ETimeParseStatus" title="enum ETimeParseStatus"><span class="type">ETimeParseStatus</span></a> result code indicating whether
<em class="parameter"><code>value</code></em>
was an empty string, a valid date, or an invalid date.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-time-format-date-and-time"></a><h3>e_time_format_date_and_time ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_time_format_date_and_time (<em class="parameter"><code><span class="type">struct tm</span> *date_tm</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> use_24_hour_format</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> show_midnight</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> show_zero_seconds</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *buffer</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> buffer_size</code></em>);</pre>
<p>Creates a string representation of the time value <em class="parameter"><code>date_tm</code></em>
and
stores it in <em class="parameter"><code>buffer</code></em>
. <em class="parameter"><code>buffer_size</code></em>
should be at least 64 to be
safe. If <em class="parameter"><code>show_midnight</code></em>
is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>, and the time is midnight, then
only the date is stored in <em class="parameter"><code>buffer</code></em>
. If <em class="parameter"><code>show_zero_seconds</code></em>
is
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>, then if the time has zero seconds only the hour and minute
of the time are stored in <em class="parameter"><code>buffer</code></em>
.</p>
<div class="refsect3">
<a name="e-time-format-date-and-time.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>date_tm</p></td>
<td class="parameter_description"><p>The <a class="link" href="eds-e-data-server-util.html#tm" title="struct tm"><span class="type">tm</span></a> to convert to a string.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>use_24_hour_format</p></td>
<td class="parameter_description"><p>A <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>show_midnight</p></td>
<td class="parameter_description"><p>A <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>show_zero_seconds</p></td>
<td class="parameter_description"><p>A <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>buffer</p></td>
<td class="parameter_description"><p>A <span class="type">char</span> buffer to store the time string in.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>buffer_size</p></td>
<td class="parameter_description"><p>The length of <em class="parameter"><code>buffer</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-time-format-time"></a><h3>e_time_format_time ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_time_format_time (<em class="parameter"><code><span class="type">struct tm</span> *date_tm</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> use_24_hour_format</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> show_zero_seconds</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *buffer</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> buffer_size</code></em>);</pre>
<p>Creates a string representation of a time value in <em class="parameter"><code>date_tm</code></em>
and
stores it in <em class="parameter"><code>buffer</code></em>
. <em class="parameter"><code>buffer_size</code></em>
should be at least 64.</p>
<div class="refsect3">
<a name="e-time-format-time.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>date_tm</p></td>
<td class="parameter_description"><p>The <a class="link" href="eds-e-data-server-util.html#tm" title="struct tm"><span class="type">tm</span></a> to convert to a string.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>use_24_hour_format</p></td>
<td class="parameter_description"><p>A <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>show_zero_seconds</p></td>
<td class="parameter_description"><p>A <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>buffer</p></td>
<td class="parameter_description"><p>The <span class="type">char</span> buffer to store the result in.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>buffer_size</p></td>
<td class="parameter_description"><p>The length of <em class="parameter"><code>buffer</code></em>
.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-mktime-utc"></a><h3>e_mktime_utc ()</h3>
<pre class="programlisting"><span class="returnvalue">time_t</span>
e_mktime_utc (<em class="parameter"><code><span class="type">struct tm</span> *tm</code></em>);</pre>
<p>Like mktime(3), but assumes UTC instead of local timezone.</p>
<div class="refsect3">
<a name="e-mktime-utc.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>tm</p></td>
<td class="parameter_description"><p>The <a class="link" href="eds-e-data-server-util.html#tm" title="struct tm"><span class="type">tm</span></a> to convert to a calendar time representation.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-mktime-utc.returns"></a><h4>Returns</h4>
<p> The calendar time representation of <em class="parameter"><code>tm</code></em>
.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-localtime-with-offset"></a><h3>e_localtime_with_offset ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_localtime_with_offset (<em class="parameter"><code><span class="type">time_t</span> tt</code></em>,
<em class="parameter"><code><span class="type">struct tm</span> *tm</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *offset</code></em>);</pre>
<p>Converts the calendar time time representation <em class="parameter"><code>tt</code></em>
to a broken-down
time representation, store in <em class="parameter"><code>tm</code></em>
, and provides the offset in
seconds from UTC time, stored in <em class="parameter"><code>offset</code></em>
.</p>
<div class="refsect3">
<a name="e-localtime-with-offset.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>tt</p></td>
<td class="parameter_description"><p>The <span class="type">time_t</span> to convert.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>tm</p></td>
<td class="parameter_description"><p>The <a class="link" href="eds-e-data-server-util.html#tm" title="struct tm"><span class="type">tm</span></a> to store the result in.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>offset</p></td>
<td class="parameter_description"><p>The <span class="type">int</span> to store the offset in.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="e-time-get-d-fmt-with-4digit-year"></a><h3>e_time_get_d_fmt_with_4digit_year ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
e_time_get_d_fmt_with_4digit_year (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Retrieves a date format string with a 4-digit year (D_FMT on systems with
<code class="function">nl_langinfo()</code> available). Free the returned string with <a href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>.</p>
<div class="refsect3">
<a name="e-time-get-d-fmt-with-4digit-year.returns"></a><h4>Returns</h4>
<p> a newly-allocated date format string</p>
</div>
<p class="since">Since: <a class="link" href="api-index-2.22.html" title="Index of new symbols in 2.22">2.22</a></p>
</div>
</div>
<div class="refsect1">
<a name="eds-e-time-utils.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="ETimeParseStatus"></a><h3>enum ETimeParseStatus</h3>
<div class="refsect3">
<a name="ETimeParseStatus.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="E-TIME-PARSE-OK:CAPS"></a>E_TIME_PARSE_OK</p></td>
<td class="enum_member_description">
<p>The time string was parsed successfully.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="E-TIME-PARSE-NONE:CAPS"></a>E_TIME_PARSE_NONE</p></td>
<td class="enum_member_description">
<p>The time string was empty.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="E-TIME-PARSE-INVALID:CAPS"></a>E_TIME_PARSE_INVALID</p></td>
<td class="enum_member_description">
<p>The time string was not formatted correctly.</p>
</td>
<td class="enum_member_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>
|