diff options
Diffstat (limited to 'docs/man/nng_strfree.3.adoc')
| -rw-r--r-- | docs/man/nng_strfree.3.adoc | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/man/nng_strfree.3.adoc b/docs/man/nng_strfree.3.adoc index 2e6569a8..9b91306f 100644 --- a/docs/man/nng_strfree.3.adoc +++ b/docs/man/nng_strfree.3.adoc @@ -25,20 +25,20 @@ void nng_strfree(char *str); == DESCRIPTION The `nng_strfree()` function deallocates the string _str_. -This is equivalent to using <<nng_free.3#,`nng_free()`>> with +This is equivalent to using `<<nng_free.3#,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.3#,`nng_strdup()`>> or -<<nng_alloc.3#,`nng_alloc()`>>. +by `<<nng_strdup.3#,nng_strdup()>>` or +`<<nng_alloc.3#,nng_alloc()>>`. 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.3#,`nng_strdup()`>> is modified to be shorter, then +`<<nng_strdup.3#,nng_strdup()>>` is modified to be shorter, then it is incorrect to call this function. -(The <<nng_free.3#,`nng_free()`>> function can be used instead in that +(The `<<nng_free.3#,nng_free()>>` function can be used instead in that case, using the length of the original string plus one for the size.) == RETURN VALUES |