diff options
| author | Richard Levitte <levitte@openssl.org> | 2017-06-27 23:08:54 +0200 |
|---|---|---|
| committer | Richard Levitte <levitte@openssl.org> | 2017-06-29 11:55:33 +0200 |
| commit | 6fc1d33c90015d3ad5738ec99aaa12fdb9640295 (patch) | |
| tree | 9c572c197388d8a0cf406df1b6e67edad320ae47 /doc | |
| parent | f95c439804bc227818b4290939569b515d730a63 (diff) | |
| download | openssl-6fc1d33c90015d3ad5738ec99aaa12fdb9640295.zip openssl-6fc1d33c90015d3ad5738ec99aaa12fdb9640295.tar.gz openssl-6fc1d33c90015d3ad5738ec99aaa12fdb9640295.tar.bz2 | |
STORE 'file' scheme loader: refactor the treatment of matches
Sometimes, 'file_load' couldn't really distinguish if a file handler
matched the data and produced an error or if it didn't match the data
at all.
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/3542)
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/man3/OSSL_STORE_open.pod | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/doc/man3/OSSL_STORE_open.pod b/doc/man3/OSSL_STORE_open.pod index b63156a..9a05443 100644 --- a/doc/man3/OSSL_STORE_open.pod +++ b/doc/man3/OSSL_STORE_open.pod @@ -69,6 +69,8 @@ of data. OSSL_STORE_error() takes a B<OSSL_STORE_CTX> and checks if an error occured in the last OSSL_STORE_load() call. +Note that it may still be meaningful to try and load more objects, unless +OSSL_STORE_eof() shows that the end of data has been reached. OSSL_STORE_close() takes a B<OSSL_STORE_CTX>, closes the channel that was opened by OSSL_STORE_open() and frees all other information that was stored in the @@ -105,8 +107,13 @@ should be taken or not. =head1 RETURN VALUES -OSSL_STORE_open() and OSSL_STORE_load() return a pointer to a B<OSSL_STORE_CTX> -on success, or B<NULL> on failure. +OSSL_STORE_open() returns a pointer to a B<OSSL_STORE_CTX> on success, or +B<NULL> on failure. + +OSSL_STORE_load() returns a pointer to a B<OSSL_STORE_INFO> on success, or +B<NULL> on error or when end of data is reached. +Use OSSL_STORE_error() and OSSL_STORE_eof() to determine the meaning of a +returned B<NULL>. OSSL_STORE_eof() returns 1 if the end of data has been reached, otherwise 0. |