summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_intervaltomilliseconds.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/nspr/reference/pr_intervaltomilliseconds.rst')
-rw-r--r--docs/nspr/reference/pr_intervaltomilliseconds.rst34
1 files changed, 34 insertions, 0 deletions
diff --git a/docs/nspr/reference/pr_intervaltomilliseconds.rst b/docs/nspr/reference/pr_intervaltomilliseconds.rst
new file mode 100644
index 0000000000..a68c4534bb
--- /dev/null
+++ b/docs/nspr/reference/pr_intervaltomilliseconds.rst
@@ -0,0 +1,34 @@
+PR_IntervalToMilliseconds
+=========================
+
+Converts platform-dependent intervals to standard clock milliseconds.
+
+
+Syntax
+------
+
+.. code::
+
+ #include <prinrval.h>
+
+ PRUint32 PR_IntervalToMilliseconds(PRIntervalTime ticks);
+
+
+Parameter
+~~~~~~~~~
+
+``ticks``
+ The number of platform-dependent intervals to convert.
+
+
+Returns
+~~~~~~~
+
+Equivalent in milliseconds of the value passed in the ``ticks``
+parameter.
+
+
+Description
+-----------
+
+Conversion may cause overflow, which is not reported.