diff options
Diffstat (limited to 'docs/man/nng_url_clone.3.adoc')
| -rw-r--r-- | docs/man/nng_url_clone.3.adoc | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/docs/man/nng_url_clone.3.adoc b/docs/man/nng_url_clone.3.adoc new file mode 100644 index 00000000..b6553f6c --- /dev/null +++ b/docs/man/nng_url_clone.3.adoc @@ -0,0 +1,44 @@ += nng_url_clone(3) +// +// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech> +// Copyright 2018 Capitar IT Group BV <info@capitar.com> +// +// 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_url_clone - clone URL structure + +== SYNOPSIS + +[source, c] +---- +#include <nng/nng.h> + +int nng_url_clone(nng_url **dup, nng_url *orig); +---- + +== DESCRIPTION + +The `nng_url_clone()` makes a clone of the original URL structure _orig_, and +saves the result in the location pointed by _dup_. +This clone includes fully duplicating each of the member fields. + +== RETURN VALUES + +This function returns 0 on success, and non-zero otherwise. + +== ERRORS + +`NNG_ENOMEM`:: Insufficient free memory exists to duplicate a message. + +== SEE ALSO + +<<nng_url_free.3#,nng_url_free(3)>>, +<<nng_url_parse.3#,nng_url_parse(3)>>, +<<nng_strerror.3#,nng_strerror(3)>>, +<<nng.7#,nng(7)>> |