summaryrefslogtreecommitdiff
path: root/docs/ref/util/nng_strfree.adoc
blob: a74c90d95af5d032951656a1abc6e615f07ed636 (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
## nng_strfree

Free memory.

### Synopsis

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

void nng_strfree(char *str);
```

### Description

The `nng_strfree` function deallocates the string _str_.
This is equivalent to using xref:nng_free.adoc[`nng_free`] with the length of _str_ plus one (for the `NUL` terminating byte) as the size.

IMPORTANT: This should only be used with strings that were allocated by xref:nng_strdup.adoc[`nng_strdup`] or xref:nng_alloc.adoc[`nng_alloc`].
In all cases, the allocation size of the string must be the same as `strlen(str) + 1`.

IMPORTANT: Consequently, if the a string created with xref:nng_strdup.adoc[`nng_strdup`] is modified to be shorter, then it is incorrect to call this function.
(The xref:nng_free.adoc[`nng_free`] function can be used instead in that case, using the length of the original string plus one for the size.)

### See Also

xref:nng_alloc.adoc[nng_alloc],
xref:nng_free.adoc[nng_free],
xref:nng_strdup.adoc[nng_strdup]