File: pl_strdup.rst

package info (click to toggle)
thunderbird 1%3A115.16.0esr-1~deb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 3,476,252 kB
  • sloc: cpp: 6,972,150; javascript: 5,209,211; ansic: 3,507,222; python: 1,137,609; asm: 432,531; xml: 205,149; java: 175,761; sh: 116,485; makefile: 22,152; perl: 13,971; objc: 12,561; yacc: 4,583; pascal: 2,840; lex: 1,720; ruby: 1,075; exp: 762; sql: 666; awk: 580; php: 436; lisp: 430; sed: 70; csh: 10
file content (48 lines) | stat: -rw-r--r-- 868 bytes parent folder | download | duplicates (18)
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>`__.