summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/prseekwhence.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/nspr/reference/prseekwhence.rst')
-rw-r--r--docs/nspr/reference/prseekwhence.rst35
1 files changed, 35 insertions, 0 deletions
diff --git a/docs/nspr/reference/prseekwhence.rst b/docs/nspr/reference/prseekwhence.rst
new file mode 100644
index 0000000000..4d6ae71371
--- /dev/null
+++ b/docs/nspr/reference/prseekwhence.rst
@@ -0,0 +1,35 @@
+PRSeekWhence
+============
+
+Specifies how to interpret the ``offset`` parameter in setting the file
+pointer associated with the ``fd`` parameter for the :ref:`PR_Seek` and
+:ref:`PR_Seek64` functions.
+
+
+Syntax
+------
+
+.. code::
+
+ #include <prio.h>
+
+ typedef PRSeekWhence {
+ PR_SEEK_SET = 0,
+ PR_SEEK_CUR = 1,
+ PR_SEEK_END = 2
+ } PRSeekWhence;
+
+
+Enumerators
+~~~~~~~~~~~
+
+The enumeration has the following enumerators:
+
+``PR_SEEK_SET``
+ Sets the file pointer to the value of the ``offset`` parameter.
+``PR_SEEK_CUR``
+ Sets the file pointer to its current location plus the value of the
+ ``offset`` parameter.
+``PR_SEEK_END``
+ Sets the file pointer to the size of the file plus the value of the
+ ``offset`` parameter.