File: pr_gmtparameters.rst

package info (click to toggle)
firefox-esr 115.14.0esr-1~deb11u1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 3,659,200 kB
  • sloc: cpp: 6,676,648; javascript: 5,690,850; ansic: 3,328,545; python: 1,120,605; asm: 397,163; xml: 180,531; java: 178,838; sh: 68,930; makefile: 20,999; perl: 12,595; objc: 12,561; yacc: 4,583; cs: 3,846; pascal: 2,840; lex: 1,720; ruby: 1,079; exp: 762; php: 436; lisp: 258; awk: 247; sql: 66; sed: 54; csh: 10
file content (47 lines) | stat: -rw-r--r-- 995 bytes parent folder | download | duplicates (18) 
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
 
PR_GMTParameters
================

Returns the time zone offset information that maps the specified
:ref:`PRExplodedTime` to GMT.

.. note::

   **Note:** Since this function requires GMT as input, its primary use
   is as "filler" for cases in which you need a do-nothing callback.


Syntax
------

.. code::

   #include <prtime.h>

   PRTimeParameters PR_GMTParameters (
      const PRExplodedTime *gmt);


Parameter
~~~~~~~~~

``gmt``
   A pointer to the clock/calendar time whose offsets are to be
   determined. This time should be specified in GMT.


Returns
~~~~~~~

A time parameters structure that expresses the time zone offsets at the
specified time.


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

This is a frequently-used time parameter callback function. You don't
normally call it directly; instead, you pass it as a parameter to
``PR_ExplodeTime()`` or ``PR_NormalizeTime()``.

This is a trivial function; for any input, it returns a
:ref:`PRTimeParameters` structure with both fields set to zero.