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_strfree.md | 41 ++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 docs/reference/src/util/nng_strfree.md (limited to 'docs/reference/src/util/nng_strfree.md') diff --git a/docs/reference/src/util/nng_strfree.md b/docs/reference/src/util/nng_strfree.md new file mode 100644 index 00000000..3cebb7f6 --- /dev/null +++ b/docs/reference/src/util/nng_strfree.md @@ -0,0 +1,41 @@ +# nng_strfree + +## NAME + +nng_strfree --- free memory + +## SYNOPSIS + +```c +#include + +void nng_strfree(char *str); +``` + +## DESCRIPTION + +The `nng_strfree()` function deallocates the string _str_. +This is equivalent to using [`nng_free()`][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 [`nng_strdup()`][nng_strdup] or [`nng_alloc()`](nng_alloc.md). +> 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 +> [`nng_strdup()`][nng_strfree] is modified to be shorter, then +> it is incorrect to call this function. +> (The [`nng_free()`](nng_Free.md) function can be used instead in that +> case, using the length of the original string plus one for the size.) + +## SEE ALSO + +[nng_alloc][nng_alloc], +[nng_free][nng_free], +[nng_strdup][nng_strdup] + +{{#include ../refs.md}} -- cgit v1.2.3-70-g09d2