summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_newzap.rst
blob: 55d77885b143e4e41027928ba2e1e5d9e95f91b8 (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
PR_NEWZAP
=========

Allocates and clears memory from the heap for an instance of a given
type.


Syntax
------

.. code::

   #include <prmem.h>

   _type * PR_NEWZAP(_struct);


Parameter
~~~~~~~~~

``_struct``
   The name of a type.


Returns
~~~~~~~

An pointer to a buffer sized to contain the type ``_struct``, or if the
allocation attempt fails, ``NULL``. The bytes in the buffer are all
initialized to 0. Call ``PR_GetError()`` to retrieve the error returned
by the libc function.


Description
-----------

This macro allocates an instance of the specified type from the heap and
sets the content of that memory to zero.