summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_calloc.rst
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--docs/nspr/reference/pr_calloc.rst42
1 files changed, 42 insertions, 0 deletions
diff --git a/docs/nspr/reference/pr_calloc.rst b/docs/nspr/reference/pr_calloc.rst
new file mode 100644
index 0000000000..b36a89d9b4
--- /dev/null
+++ b/docs/nspr/reference/pr_calloc.rst
@@ -0,0 +1,42 @@
+PR_Calloc
+=========
+
+Allocates zeroed memory from the heap for a number of objects of a given
+size.
+
+
+Syntax
+------
+
+.. code::
+
+ #include <prmem.h>
+
+ void *PR_Calloc (
+ PRUint32 nelem,
+ PRUint32 elsize);
+
+
+Parameters
+~~~~~~~~~~
+
+``nelem``
+ The number of elements of size ``elsize`` to be allocated.
+``elsize``
+ The size of an individual element.
+
+
+Returns
+~~~~~~~
+
+An untyped pointer to the allocated memory, or if the allocation attempt
+fails, ``NULL``. Call ``PR_GetError()`` to retrieve the error returned
+by the libc function ``malloc()``.
+
+
+Description
+-----------
+
+This function allocates memory on the heap for the specified number of
+objects of the specified size. All bytes in the allocated memory are
+cleared.