diff options
| author | Pauli <ppzgs1@gmail.com> | 2021-03-10 11:46:00 +1000 |
|---|---|---|
| committer | Pauli <ppzgs1@gmail.com> | 2021-03-12 09:14:00 +1000 |
| commit | 3c5ce1ce81bfcf84a64c93c74eb40c90a2a49c54 (patch) | |
| tree | 40df6a995689e0c5a7958384e27f8d41b504f18d /doc | |
| parent | 7bbfbc8239b1d9edd36830e08c30f9681baba4c7 (diff) | |
doc: describe the return from ossl_provider_forall_loaded()
Also correct an incorrect statement about non-activated providers.
Reviewed-by: Shane Lontis <shane.lontis@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/14489)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/internal/man3/ossl_provider_new.pod | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/doc/internal/man3/ossl_provider_new.pod b/doc/internal/man3/ossl_provider_new.pod index dbf1e7cc5a..43ad7556cf 100644 --- a/doc/internal/man3/ossl_provider_new.pod +++ b/doc/internal/man3/ossl_provider_new.pod @@ -200,7 +200,7 @@ passed back to some of the provider functions. ossl_provider_forall_loaded() iterates over all the currently "activated" providers, and calls I<cb> for each of them. If no providers have been "activated" yet, it tries to activate all -available fallback providers and tries another iteration. +available fallback providers before iterating over them. ossl_provider_name() returns the name that was given with ossl_provider_new(). @@ -287,6 +287,10 @@ it has been incremented. ossl_provider_free() doesn't return any value. +ossl_provider_forall_loaded() returns 1 if the callback was called for all +activated providers. A return value of 0 means that the callback was not +called for any activated providers. + ossl_provider_set_module_path(), ossl_provider_set_fallback(), ossl_provider_activate(), ossl_provider_activate_leave_fallbacks() and ossl_provider_deactivate() return 1 on success, or 0 on error. |