From 7dd81b3c116127f8eed3dc6f05c62ec36b0097d8 Mon Sep 17 00:00:00 2001 From: Garrett D'Amore Date: Sun, 6 Oct 2024 21:53:19 -0700 Subject: Converted nng_strdup and nng_strfree to mdbook. --- docs/man/nng_strdup.3.adoc | 56 ---------------------------------------------- 1 file changed, 56 deletions(-) delete mode 100644 docs/man/nng_strdup.3.adoc (limited to 'docs/man/nng_strdup.3.adoc') diff --git a/docs/man/nng_strdup.3.adoc b/docs/man/nng_strdup.3.adoc deleted file mode 100644 index 91c4854d..00000000 --- a/docs/man/nng_strdup.3.adoc +++ /dev/null @@ -1,56 +0,0 @@ -= nng_strdup(3) -// -// Copyright 2018 Staysail Systems, Inc. -// Copyright 2018 Capitar IT Group BV -// -// This document is supplied under the terms of the MIT License, a -// copy of which should be located in the distribution where this -// file was obtained (LICENSE.txt). A copy of the license may also be -// found online at https://opensource.org/licenses/MIT. -// - -== NAME - -nng_strdup - duplicate string - -== SYNOPSIS - -[source, c] ----- -#include - -char *nng_strdup(const char *src); ----- - -== DESCRIPTION - -The `nng_strdup()` duplicates the string _src_ and returns it. - -This is logically equivalent to using xref:nng_alloc.3.adoc[`nng_alloc()`] -to allocate a region of memory of `strlen(s) + 1` bytes, and then -using `strcpy()` to copy the string into the destination before -returning it. - -The returned string should be deallocated with -xref:nng_strfree.3.adoc[`nng_strfree()`], or may be deallocated using the -xref:nng_free.3.adoc[`nng_free()`] using the length of the returned string plus -one (for the `NUL` terminating byte). - -IMPORTANT: Do not use the system `free()` or similar functions to deallocate -the string, since those may use a different memory arena! - -== RETURN VALUES - -This function returns the new string on success, and `NULL` on failure. - -== ERRORS - -No errors are returned, but a `NULL` return value should be -treated the same as `NNG_ENOMEM`. - -== SEE ALSO - -[.text-left] -xref:nng_alloc.3.adoc[nng_alloc(3)], -xref:nng_free.3.adoc[nng_free(3)], -xref:nng.7.adoc[nng(7)] -- cgit v1.2.3-70-g09d2