summaryrefslogtreecommitdiff
path: root/docs/reference/src/util/nng_strdup.md
blob: 363af3048bd8cb4c6ecef5ff01b8eaf244fee79b (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
# nng_strdup

## NAME

nng_strdup --- duplicate string

## SYNOPSIS

```c
#include <nng/nng.h>

char *nng_strdup(const char *src);
```

## DESCRIPTION

The `nng_strdup()` duplicates the string _src_ and returns it.

This is logically equivalent to using [`nng_alloc()`][nng_alloc]
to allocate a region of memory of `strlen(s) + 1` bytes, and then
using `strcpy()` to copy the string into the destination before
returning it.

The returned string should be deallocated with
[`nng_strfree()`][nng_strfree], or may be deallocated using the
[`nng_free()`][nng_free] using the length of the returned string plus
one (for the `NUL` terminating byte).

> [!IMPORTANT]
> Do not use the system `free()` or similar functions to deallocate
> the string, since those may use a different memory arena!

## RETURN VALUES

This function returns the new string on success, and `NULL` on failure.

## ERRORS

No errors are returned, but a `NULL` return value should be
treated the same as `NNG_ENOMEM`.

## SEE ALSO

[nng_alloc.md][nng_alloc],
[nng_free.md][nng_free],
[nng_strfree.md][nng_strfree]

{{#include ../refs.md}}