summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pr_malloc.rst
blob: d475ab6a4b9ac9f8454d1cc832b367efb8b332fa (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
PR_MALLOC
=========

Allocates memory of a specified size from the heap.


Syntax
------

.. code::

   #include <prmem.h>

   void * PR_MALLOC(_bytes);


Parameter
~~~~~~~~~

``_bytes``
   Size of the requested memory block.


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 macro allocates memory of the requested size from the heap.