summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_delete_.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/nspr/reference/pr_delete_.rst')
-rw-r--r--docs/nspr/reference/pr_delete_.rst37
1 files changed, 37 insertions, 0 deletions
diff --git a/docs/nspr/reference/pr_delete_.rst b/docs/nspr/reference/pr_delete_.rst
new file mode 100644
index 0000000000..c441801d25
--- /dev/null
+++ b/docs/nspr/reference/pr_delete_.rst
@@ -0,0 +1,37 @@
+PR_DELETE
+=========
+
+
+Allocates memory of a specified size from the heap.
+
+
+Syntax
+------
+
+.. code::
+
+ #include <prmem.h>
+
+ void PR_DELETE(_ptr);
+
+
+Parameter
+~~~~~~~~~
+
+``_ptr``
+ The address of memory to be returned to the heap. Must be an lvalue
+ (an expression that can appear on the left side of an assignment
+ statement).
+
+
+Returns
+~~~~~~~
+
+Nothing.
+
+
+Description
+-----------
+
+This macro returns allocated memory to the heap from the specified
+location and sets ``_ptr`` to ``NULL``.