summaryrefslogtreecommitdiffstats
path: root/docs/nspr/reference/pl_strdup.rst
blob: fcced90ec44436a4b9e2c9937b0844537ff4dd24 (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
43
44
45
46
47
48
PL_strdup
=========

Returns a pointer to a new memory node in the NSPR heap containing a
copy of a specified string.


Syntax
~~~~~~

.. code::

   #include <plstr.h>

   char *PL_strdup(const char *s);


Parameter
~~~~~~~~~

The function has a single parameter:

``s``
   The string to copy, may be ``NULL``.


Returns
~~~~~~~

The function returns one of these values:

-  If successful, a pointer to a copy of the specified string.
-  If the memory allocation fails, ``NULL``.


Description
~~~~~~~~~~~

To accommodate the terminator, the size of the allocated memory is one
greater than the length of the string being copied. A ``NULL`` argument,
like a zero-length argument, results in a pointer to a one-byte block of
memory containing the null value.

Notes
~~~~~

The memory allocated by :ref:`PL_strdup` should be freed with
`PL_strfree </en/PL_strfree>`__.