diff options
| author | Paul Yang <yang.yang@baishancloud.com> | 2017-12-25 17:50:39 +0800 |
|---|---|---|
| committer | Matt Caswell <matt@openssl.org> | 2018-01-16 17:34:08 +0000 |
| commit | 1f13ad311367c07fe71c9f911195cd25948184d7 (patch) | |
| tree | 6293d1b483575295ea3786c1a07f3895141aedb6 /doc/man3/BIO_s_mem.pod | |
| parent | 82992a4130e668c14ff66fca26170629b23c4556 (diff) | |
| download | openssl-1f13ad311367c07fe71c9f911195cd25948184d7.tar.gz | |
Add missing 'RETURN VALUES' sections in doc
All missing sections are added.
Reviewed-by: Andy Polyakov <appro@openssl.org>
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/4976)
Diffstat (limited to 'doc/man3/BIO_s_mem.pod')
| -rw-r--r-- | doc/man3/BIO_s_mem.pod | 13 |
1 files changed, 11 insertions, 2 deletions
diff --git a/doc/man3/BIO_s_mem.pod b/doc/man3/BIO_s_mem.pod index 0b559e57a5..c53a11a66a 100644 --- a/doc/man3/BIO_s_mem.pod +++ b/doc/man3/BIO_s_mem.pod @@ -22,7 +22,7 @@ BIO_get_mem_ptr, BIO_new_mem_buf - memory BIO =head1 DESCRIPTION -BIO_s_mem() return the memory BIO method function. +BIO_s_mem() returns the memory BIO method function. A memory BIO is a source/sink BIO which uses memory for its I/O. Data written to a memory BIO is stored in a BUF_MEM structure which is extended @@ -113,9 +113,18 @@ Extract the BUF_MEM structure from a memory BIO and then free up the BIO: BIO_set_close(mem, BIO_NOCLOSE); /* So BIO_free() leaves BUF_MEM alone */ BIO_free(mem); +=head1 RETURN VALUES + +BIO_s_mem() and BIO_s_secmem() return a valid memory B<BIO_METHOD> structure. + +BIO_set_mem_eof_return(), BIO_get_mem_data(), BIO_set_mem_buf() and BIO_get_mem_ptr() +return 1 on success or a value which is less than or equal to 0 if an error occurred. + +BIO_new_mem_buf() returns a valid B<BIO> structure on success or NULL on error. + =head1 COPYRIGHT -Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2000-2017 The OpenSSL Project Authors. All Rights Reserved. Licensed under the OpenSSL license (the "License"). You may not use this file except in compliance with the License. You can obtain a copy |