summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_explodetime.rst
blob: 066ccfcd01926e134d0ba2c6c375cc63f644804a (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
PR_ExplodeTime
==============

Converts an absolute time to a clock/calendar time.


Syntax
------

.. code::

   #include <prtime.h>

   void PR_ExplodeTime(
      PRTime usecs,
      PRTimeParamFn params,
      PRExplodedTime *exploded);


Parameters
~~~~~~~~~~

The function has these parameters:

``usecs``
   An absolute time in the :ref:`PRTime` format.
``params``
   A time parameter callback function.
``exploded``
   A pointer to a location where the converted time can be stored. This
   location must be preallocated by the caller.


Returns
~~~~~~~

Nothing; the buffer pointed to by ``exploded`` is filled with the
exploded time.


Description
-----------

This function converts the specified absolute time to a clock/calendar
time in the specified time zone. Upon return, the location pointed to by
the exploded parameter contains the converted time value.