diff options
| author | Garrett D'Amore <garrett@damore.org> | 2018-03-20 18:38:54 -0700 |
|---|---|---|
| committer | Garrett D'Amore <garrett@damore.org> | 2018-03-20 18:42:23 -0700 |
| commit | 6df40cb6eea9a4220d61c4c927ce5a857a12a338 (patch) | |
| tree | ac4b7ecbcb41a456eb4d0429fc180047656371ba /docs/man/nng_alloc.3.adoc | |
| parent | 9ca901c1b70b17d851426483d9f54611cfa8e395 (diff) | |
| download | nng-6df40cb6eea9a4220d61c4c927ce5a857a12a338.tar.gz nng-6df40cb6eea9a4220d61c4c927ce5a857a12a338.tar.bz2 nng-6df40cb6eea9a4220d61c4c927ce5a857a12a338.zip | |
fixes #301 String option handling for getopt
Diffstat (limited to 'docs/man/nng_alloc.3.adoc')
| -rw-r--r-- | docs/man/nng_alloc.3.adoc | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/docs/man/nng_alloc.3.adoc b/docs/man/nng_alloc.3.adoc index 7d7adf07..a43140d1 100644 --- a/docs/man/nng_alloc.3.adoc +++ b/docs/man/nng_alloc.3.adoc @@ -33,17 +33,19 @@ case it can be directly passed to <<nng_send.3#,`nng_send()`>> using the flag `NNG_FLAG_ALLOC`. Alternatively, it can be freed when no longer needed using <<nng_free.3#,`nng_free()`>>. -WARNING: Do not use the system `free()` function to release this memory. +IMPORTANT: Do not use the system `free()` function to release this memory. On some platforms this may work, but it is not guaranteed and may lead to a crash or other undesirable and unpredictable behavior. == RETURN VALUES -This function returns 0 on success, and non-zero otherwise. +This function returns a pointer to the allocated memory on success, +and `NULL` otherwise. == ERRORS -`NNG_ENOMEM`:: Insufficient free memory exists. +No errors are returned, but a `NULL` return value should be +treated the same as `NNG_ENOMEM`. == SEE ALSO |