summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_calloc.rst
blob: b36a89d9b47c458ec9f4da200376d5fd046b952a (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
34
35
36
37
38
39
40
41
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.