diff options
| author | Garrett D'Amore <garrett@damore.org> | 2025-01-01 19:11:54 -0800 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2025-01-01 19:11:54 -0800 |
| commit | f293e96b03b22c6a91140b118c4e15059e285543 (patch) | |
| tree | 1a7c333e6e5a4209831ab2e7aa8c2a43d98aa2e8 /docs/man/nng_ctx_id.3.adoc | |
| parent | f7bf24f429cbc488b861ab1b1e4cf1983af56295 (diff) | |
| download | nng-f293e96b03b22c6a91140b118c4e15059e285543.tar.gz nng-f293e96b03b22c6a91140b118c4e15059e285543.tar.bz2 nng-f293e96b03b22c6a91140b118c4e15059e285543.zip | |
docs: convert the context docs to mdbook
Diffstat (limited to 'docs/man/nng_ctx_id.3.adoc')
| -rw-r--r-- | docs/man/nng_ctx_id.3.adoc | 51 |
1 files changed, 0 insertions, 51 deletions
diff --git a/docs/man/nng_ctx_id.3.adoc b/docs/man/nng_ctx_id.3.adoc deleted file mode 100644 index 51b833a8..00000000 --- a/docs/man/nng_ctx_id.3.adoc +++ /dev/null @@ -1,51 +0,0 @@ -= nng_ctx_id(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_ctx_id - return numeric context identifier - -== SYNOPSIS - -[source, c] ----- -#include <nng/nng.h> - -int nng_ctx_id(nng_ctx c); ----- - -== DESCRIPTION - -The `nng_ctx_id()` function returns a positive identifier for the context _c_, -if it is valid. -Otherwise it returns `-1`. - -NOTE: A context is considered valid if it was ever opened with -xref:nng_ctx_open.3.adoc[`nng_ctx_open()`] function. -Contexts that are allocated on the stack or statically should be -initialized with the macro -xref:nng_ctx.5.adoc#NNG_CTX_INITIALIZER[`NNG_CTX_INITIALIZER`] to ensure that -they cannot be confused with a valid context before they are opened. - -== RETURN VALUES - -This function returns the positive value for the context identifier, or -`-1` if the context is invalid. - -== ERRORS - -None. - -== SEE ALSO - -[.text-left] -xref:nng_ctx.5.adoc[nng_ctx(5)], -xref:nng.7.adoc[nng(7)] |
