summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_freeif.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/nspr/reference/pr_freeif.rst')
-rw-r--r--docs/nspr/reference/pr_freeif.rst34
1 files changed, 34 insertions, 0 deletions
diff --git a/docs/nspr/reference/pr_freeif.rst b/docs/nspr/reference/pr_freeif.rst
new file mode 100644
index 0000000000..3d8f9baba5
--- /dev/null
+++ b/docs/nspr/reference/pr_freeif.rst
@@ -0,0 +1,34 @@
+PR_FREEIF
+=========
+
+Conditionally frees allocated memory.
+
+
+Syntax
+------
+
+.. code::
+
+ #include <prmem.h>
+
+ void PR_FREEIF(_ptr);
+
+
+Parameter
+~~~~~~~~~
+
+``_ptr``
+ The address of memory to be returned to the heap.
+
+
+Returns
+~~~~~~~
+
+Nothing.
+
+
+Description
+-----------
+
+This macro returns memory to the heap when ``_ptr`` is not ``NULL``. If
+``_ptr`` is ``NULL``, the macro has no effect.