fune/docs/nspr/reference/pr_new.rst
2022-02-02 17:19:51 +00:00

36 lines
539 B
ReStructuredText

PR_NEW
======
Allocates memory of a specified size from the heap.
Syntax
------
.. code:: eval
#include <prmem.h>
_type * PR_NEW(_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``. Call ``PR_GetError()`` to retrieve
the error returned by the libc function.
Description
-----------
This macro allocates memory whose size is ``sizeof(_struct)`` and
returns a pointer to that memory.