Visit Mozilla.org

PL strdup

From MDC


< NSPR API Reference < String Operations

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

Contents

[edit] Syntax

#include <plstr.h>

char *PL_strdup(const char *s);

[edit] Parameter

The function has a single parameter:

s
The string to copy, may be NULL.

[edit] 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.

[edit] 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.

[edit] Notes

The memory allocated by PL_strdup should be freed with PL_strfree.