diff options
Diffstat (limited to 'docs/man/nng_dialer_get.3.adoc')
| -rw-r--r-- | docs/man/nng_dialer_get.3.adoc | 24 |
1 files changed, 1 insertions, 23 deletions
diff --git a/docs/man/nng_dialer_get.3.adoc b/docs/man/nng_dialer_get.3.adoc index e23ecd2c..29c0341a 100644 --- a/docs/man/nng_dialer_get.3.adoc +++ b/docs/man/nng_dialer_get.3.adoc @@ -1,6 +1,6 @@ = nng_dialer_get(3) // -// Copyright 2020 Staysail Systems, Inc. <info@staysail.tech> +// Copyright 2024 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 @@ -19,8 +19,6 @@ nng_dialer_get - get dialer option ---- #include <nng/nng.h> -int nng_dialer_get(nng_dialer d, const char *opt, void *val, size_t *valszp); - int nng_dialer_get_bool(nng_dialer d, const char *opt, bool *bvalp); int nng_dialer_get_int(nng_dialer d, const char *opt, int *ivalp); @@ -57,26 +55,6 @@ The forms vary based on the type of the option they take. The details of the type, size, and semantics of the option will depend on the actual option, and will be documented with the option itself. -`nng_dialer_get()`:: -This function is untyped and can be used to retrieve the value of any option. -The caller must store a pointer to a buffer to receive the value in _val_, -and the size of the buffer shall be stored at the location referenced -by _valszp_. + - + -When the function returns, the actual size of the data copied (or that -would have been copied if sufficient space were present) is stored at -the location referenced by _valszp_. -If the caller's buffer is not large -enough to hold the entire object, then the copy is truncated. -Therefore the caller should validate that the returned size in _valszp_ does not -exceed the original buffer size to check for truncation. + - + -It is acceptable to pass `NULL` for _val_ if the value in _valszp_ is zero. -This can be used to determine the size of the buffer needed to receive -the object. - -TIP: It may be easier to use one of the typed forms of this function. - `nng_dialer_get_bool()`:: This function is for options which take a Boolean (`bool`). The value will be stored at _bvalp_. |