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

Free memory.

### Synopsis

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

void nng_free(void *ptr, size_t size);
```

### Description

The `nng_free` function deallocates a memory region of size _size_, that was previously allocated by xref:nng_alloc.adoc[`nng_alloc`] or xref:nng_recv.adoc[`nng_recv`] with the ((`NNG_FLAG_ALLOC`)) flag.

IMPORTANT: It is very important that _size_ match the allocation size used to allocate the memory.

IMPORTANT: Do not attempt to use this function to deallocate memory obtained by a call to the system `malloc` or `calloc` functions, or the {cpp} `new` operator.
Doing so may result in unpredictable behavior, including corruption of application memory.

### See Also

xref:nng_alloc.adoc[nng_alloc],
xref:nng_recv.adoc[nng_recv]