summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_free.rst
blob: 577955d205f12c7a2eb9cfd3314bd4dd73372895 (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
PR_Free
=======

Frees allocated memory in the heap.


Syntax
------

.. code::

   #include <prmem.h>

   void PR_Free(void *ptr);


Parameter
~~~~~~~~~

``ptr``
   A pointer to the memory to be freed.


Returns
~~~~~~~

Nothing.


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

This function frees the memory addressed by ``ptr`` in the heap.