From 331bd5a7c360083f245fe6c82afa38dd05c4a9c9 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Sun, 24 Mar 2024 22:19:42 -0700 Subject: More org stuff --- docs/reference/src/api/nng_alloc.md | 44 ------------------------------------- 1 file changed, 44 deletions(-) delete mode 100644 docs/reference/src/api/nng_alloc.md (limited to 'docs/reference/src/api/nng_alloc.md') diff --git a/docs/reference/src/api/nng_alloc.md b/docs/reference/src/api/nng_alloc.md deleted file mode 100644 index 6cc4b21f..00000000 --- a/docs/reference/src/api/nng_alloc.md +++ /dev/null @@ -1,44 +0,0 @@ -# nng_alloc() - -## NAME - -nng_alloc --- allocate memory - -## SYNOPSIS - -```c -#include - -void *nng_alloc(size_t size); -``` - -## DESCRIPTION - -The `nng_alloc()` function allocates a contiguous memory region of -at least _size_ bytes. -The memory will be 64-bit aligned. - -The returned memory can be used to hold message buffers, in which -case it can be directly passed to [`nng_send()`](nng_send.md) using -the flag `NNG_FLAG_ALLOC`. Alternatively, it can be freed when no -longer needed using [`nng_free()`](nng_free.md). - -> [!IMPORTANT] -> Do not use the system `free()` function (or the C++ `delete` operator) to release this memory. -> On some configurations this may work, but on others it will lead to a crash or -> other unpredictable behavior. - -## RETURN VALUES - -This function returns a pointer to the allocated memory on success, -and `NULL` otherwise. - -## ERRORS - -No errors are returned, but if memory cannot be allocated then `NULL` -is returned. - -## SEE ALSO - -[nng_free()](nng_free.md), -[nng_send()](nng_send.md) -- cgit v1.2.3-70-g09d2