summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_free.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/nspr/reference/pr_free.rst')
-rw-r--r--docs/nspr/reference/pr_free.rst33
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/nspr/reference/pr_free.rst b/docs/nspr/reference/pr_free.rst
new file mode 100644
index 0000000000..577955d205
--- /dev/null
+++ b/docs/nspr/reference/pr_free.rst
@@ -0,0 +1,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.