From b779b71b00c5f5f8cb9f0ee7d8feeadf9e2dca48 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Sat, 30 Mar 2024 16:12:02 -0700 Subject: util funcs reorg --- docs/reference/src/util/nng_free.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 docs/reference/src/util/nng_free.md (limited to 'docs/reference/src/util/nng_free.md') diff --git a/docs/reference/src/util/nng_free.md b/docs/reference/src/util/nng_free.md new file mode 100644 index 00000000..e93e91e6 --- /dev/null +++ b/docs/reference/src/util/nng_free.md @@ -0,0 +1,37 @@ +# nng_free + +## NAME + +nng_free --- free memory + +## SYNOPSIS + +```c +#include + +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 [`nng_alloc()`][nng_alloc] or +[`nng_recv()`](../socket/nng_recv.md) 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 C++ `new` operator. +> Doing so may result in unpredictable +> behavior, including corruption of application memory. + +## SEE ALSO + +[nng_alloc][nng_alloc], +[nng_recv](../socket/nng_recv.md) + +{{#include ../refs.md}} -- cgit v1.2.3-70-g09d2