summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_tickspersecond.rst
blob: 362a817d9462c505665bd2754252588c2bf844c2 (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
PR_TicksPerSecond
=================

Returns the number of ticks per second currently used to determine the
value of :ref:`PRIntervalTime`.


Syntax
------

.. code::

    #include <prinrval.h>

    PRUint32 PR_TicksPerSecond(void);


Returns
~~~~~~~

An integer between 1000 and 100000 indicating the number of ticks per
second counted by :ref:`PRIntervalTime` on the current platform. This value
is platform-dependent and does not change after NSPR is initialized.


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

The value returned by ``PR_TicksPerSecond()`` lies between
``PR_INTERVAL_MIN`` and ``PR_INTERVAL_MAX``.

The relationship between a :ref:`PRIntervalTime` tick and standard clock
units is platform-dependent. PR\_\ ``PR_TicksPerSecond()`` allows you to
discover exactly what that relationship is. Seconds per tick (the
inverse of PR\_\ ``PR_TicksPerSecond()``) is always between 10
microseconds and 1 millisecond.