pr_gmtparameters.rst (995B)
1 PR_GMTParameters 2 ================ 3 4 Returns the time zone offset information that maps the specified 5 :ref:`PRExplodedTime` to GMT. 6 7 .. note:: 8 9 **Note:** Since this function requires GMT as input, its primary use 10 is as "filler" for cases in which you need a do-nothing callback. 11 12 13 Syntax 14 ------ 15 16 .. code:: 17 18 #include <prtime.h> 19 20 PRTimeParameters PR_GMTParameters ( 21 const PRExplodedTime *gmt); 22 23 24 Parameter 25 ~~~~~~~~~ 26 27 ``gmt`` 28 A pointer to the clock/calendar time whose offsets are to be 29 determined. This time should be specified in GMT. 30 31 32 Returns 33 ~~~~~~~ 34 35 A time parameters structure that expresses the time zone offsets at the 36 specified time. 37 38 39 Description 40 ----------- 41 42 This is a frequently-used time parameter callback function. You don't 43 normally call it directly; instead, you pass it as a parameter to 44 ``PR_ExplodeTime()`` or ``PR_NormalizeTime()``. 45 46 This is a trivial function; for any input, it returns a 47 :ref:`PRTimeParameters` structure with both fields set to zero.