From 7504183730d37b362ab4cb78e926d7bd90f2fd2c Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Sun, 24 Mar 2024 13:55:44 -0700 Subject: more doc updates --- docs/reference/src/api/nng_free.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 docs/reference/src/api/nng_free.md (limited to 'docs/reference/src/api') diff --git a/docs/reference/src/api/nng_free.md b/docs/reference/src/api/nng_free.md new file mode 100644 index 00000000..cc1d3308 --- /dev/null +++ b/docs/reference/src/api/nng_free.md @@ -0,0 +1,35 @@ +# 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.md) or +[`nng_recv()`](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.md), +[nng_recv()](nng_free.md) -- cgit v1.2.3-70-g09d2