diff options
author | Paul Yang <yang.yang@baishancloud.com> | 2019-02-26 13:11:10 +0800 |
---|---|---|
committer | Paul Yang <yang.yang@baishancloud.com> | 2019-02-28 21:38:19 +0800 |
commit | 4564e77ae9dd1866e8a033f03511b6a1792c024e (patch) | |
tree | 7cf8a73e48bbc158e8ba7d433f04d3709b4ce562 /doc/man3/BIO_s_file.pod | |
parent | 69f6b3ceaba493e70e1296880ea6c93e40714f0f (diff) |
Place return values after examples in doc
Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/8338)
Diffstat (limited to 'doc/man3/BIO_s_file.pod')
-rw-r--r-- | doc/man3/BIO_s_file.pod | 36 |
1 files changed, 18 insertions, 18 deletions
diff --git a/doc/man3/BIO_s_file.pod b/doc/man3/BIO_s_file.pod index 5f0cdbe105..0d6cc98c16 100644 --- a/doc/man3/BIO_s_file.pod +++ b/doc/man3/BIO_s_file.pod @@ -80,6 +80,24 @@ On Windows BIO_new_files reserves for the filename argument to be UTF-8 encoded. In other words if you have to make it work in multi- lingual environment, encode file names in UTF-8. +=head1 RETURN VALUES + +BIO_s_file() returns the file BIO method. + +BIO_new_file() and BIO_new_fp() return a file BIO or NULL if an error +occurred. + +BIO_set_fp() and BIO_get_fp() return 1 for success or 0 for failure +(although the current implementation never return 0). + +BIO_seek() returns the same value as the underlying fseek() function: +0 for success or -1 for failure. + +BIO_tell() returns the current file position. + +BIO_read_filename(), BIO_write_filename(), BIO_append_filename() and +BIO_rw_filename() return 1 for success or 0 for failure. + =head1 EXAMPLES File BIO "hello world": @@ -122,24 +140,6 @@ Alternative technique: BIO_printf(out, "Hello World\n"); BIO_free(out); -=head1 RETURN VALUES - -BIO_s_file() returns the file BIO method. - -BIO_new_file() and BIO_new_fp() return a file BIO or NULL if an error -occurred. - -BIO_set_fp() and BIO_get_fp() return 1 for success or 0 for failure -(although the current implementation never return 0). - -BIO_seek() returns the same value as the underlying fseek() function: -0 for success or -1 for failure. - -BIO_tell() returns the current file position. - -BIO_read_filename(), BIO_write_filename(), BIO_append_filename() and -BIO_rw_filename() return 1 for success or 0 for failure. - =head1 BUGS BIO_reset() and BIO_seek() are implemented using fseek() on the underlying |