summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_openanonfilemap.rst
blob: 30964c5dd71cd6af0aaa1460dfc9523949b18f9a (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
42
43
44
45
46
47
48
49
50
51
PR_OpenAnonFileMap
==================

Creates or opens a named semaphore with the specified name


Syntax
------

.. code::

   #include <prshma.h>

   NSPR_API( PRFileMap *)
   PR_OpenAnonFileMap(
     const char *dirName,
     PRSize size,
     PRFileMapProtect prot
   );


Parameters
~~~~~~~~~~

The function has the following parameters:

``dirName``
   A pointer to a directory name that will contain the anonymous file.
``size``
   The size of the shared memory.
``prot``
   How the shared memory is mapped.


Returns
~~~~~~~

Pointer to :ref:`PRFileMap` or ``NULL`` on error.


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

If the shared memory already exists, a handle is returned to that shared
memory object.

On Unix platforms, :ref:`PR_OpenAnonFileMap` uses ``dirName`` as a
directory name, without the trailing '/', to contain the anonymous file.
A filename is generated for the name.

On Windows platforms, ``dirName`` is ignored.