summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_access.rst
blob: 14fb5018b2fe55a176467c8f3f8bbc55af3c2d67 (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
37
38
39
40
41
PR_Access
=========

Determines the accessibility of a file.


Syntax
------

.. code::

   #include <prio.h>

   PRStatus PR_Access(
     const char *name,
     PRAccessHow how);


Parameters
~~~~~~~~~~

The function has the following parameters:

``name``
   The pathname of the file whose accessibility is to be determined.
``how``
   Specifies which access permission to check for. Use one of the
   following values:

    - :ref:`PR_ACCESS_READ_OK`. Test for read permission.
    - :ref:`PR_ACCESS_WRITE_OK`. Test for write permission.
    - :ref:`PR_ACCESS_EXISTS`. Check existence of file.


Returns
~~~~~~~

One of the following values:

-  If the requested access is permitted, ``PR_SUCCESS``.
-  If the requested access is not permitted, ``PR_FAILURE``.