docs/nspr/reference/pr_localtimeparameters.rst

   1 PR_LocalTimeParameters
   2 ======================
   3
   4 Returns the time zone offset information that maps the specified
   5 :ref:`PRExplodedTime` to local time.
   6
   7
   8 Syntax
   9 ------
  10
  11 .. code::
  12
  13    #include <prtime.h>
  14
  15    PRTimeParameters PR_LocalTimeParameters (
  16       const PRExplodedTime *gmt);
  17
  18
  19 Parameter
  20 ~~~~~~~~~
  21
  22 ``gmt``
  23    A pointer to the clock/calendar time whose offsets are to be
  24    determined. This time should be specified in GMT.
  25
  26
  27 Returns
  28 ~~~~~~~
  29
  30 A time parameters structure that expresses the time zone offsets at the
  31 specified time.
  32
  33
  34 Description
  35 -----------
  36
  37 This is a frequently-used time parameter callback function. You don't
  38 normally call it directly; instead, you pass it as a parameter to
  39 ``PR_ExplodeTime()`` or ``PR_NormalizeTime()``.