diff options
Diffstat (limited to 'secure/lib/libcrypto/man/BIO_get_data.3')
| -rw-r--r-- | secure/lib/libcrypto/man/BIO_get_data.3 | 38 |
1 files changed, 21 insertions, 17 deletions
diff --git a/secure/lib/libcrypto/man/BIO_get_data.3 b/secure/lib/libcrypto/man/BIO_get_data.3 index 7c4c2e020142a..4b2fefffe2554 100644 --- a/secure/lib/libcrypto/man/BIO_get_data.3 +++ b/secure/lib/libcrypto/man/BIO_get_data.3 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35) +.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== @@ -54,16 +54,20 @@ .\" Avoid warning from groff about undefined register 'F'. .de IX .. -.if !\nF .nr F 0 -.if \nF>0 \{\ -. de IX -. tm Index:\\$1\t\\n%\t"\\$2" +.nr rF 0 +.if \n(.g .if rF .nr rF 1 +.if (\n(rF:(\n(.g==0)) \{\ +. if \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" .. -. if !\nF==2 \{\ -. nr % 0 -. nr F 2 +. if !\nF==2 \{\ +. nr % 0 +. nr F 2 +. \} . \} .\} +.rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. @@ -129,7 +133,7 @@ .\" ======================================================================== .\" .IX Title "BIO_GET_DATA 3" -.TH BIO_GET_DATA 3 "2018-11-20" "1.1.1a" "OpenSSL" +.TH BIO_GET_DATA 3 "2019-02-26" "1.1.1b" "OpenSSL" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -152,29 +156,29 @@ BIO_set_data, BIO_get_data, BIO_set_init, BIO_get_init, BIO_set_shutdown, BIO_ge .IX Header "DESCRIPTION" These functions are mainly useful when implementing a custom \s-1BIO.\s0 .PP -The \fIBIO_set_data()\fR function associates the custom data pointed to by \fBptr\fR with -the \s-1BIO.\s0 This data can subsequently be retrieved via a call to \fIBIO_get_data()\fR. +The \fBBIO_set_data()\fR function associates the custom data pointed to by \fBptr\fR with +the \s-1BIO.\s0 This data can subsequently be retrieved via a call to \fBBIO_get_data()\fR. This can be used by custom BIOs for storing implementation specific information. .PP -The \fIBIO_set_init()\fR function sets the value of the \s-1BIO\s0's \*(L"init\*(R" flag to indicate +The \fBBIO_set_init()\fR function sets the value of the \s-1BIO\s0's \*(L"init\*(R" flag to indicate whether initialisation has been completed for this \s-1BIO\s0 or not. A non-zero value indicates that initialisation is complete, whilst zero indicates that it is not. Often initialisation will complete during initial construction of the \s-1BIO.\s0 For some BIOs however, initialisation may not complete until after additional steps -have occurred (for example through calling custom ctrls). The \fIBIO_get_init()\fR +have occurred (for example through calling custom ctrls). The \fBBIO_get_init()\fR function returns the value of the \*(L"init\*(R" flag. .PP -The \fIBIO_set_shutdown()\fR and \fIBIO_get_shutdown()\fR functions set and get the state of +The \fBBIO_set_shutdown()\fR and \fBBIO_get_shutdown()\fR functions set and get the state of this \s-1BIO\s0's shutdown (i.e. \s-1BIO_CLOSE\s0) flag. If set then the underlying resource is also closed when the \s-1BIO\s0 is freed. .SH "RETURN VALUES" .IX Header "RETURN VALUES" -\&\fIBIO_get_data()\fR returns a pointer to the implementation specific custom data +\&\fBBIO_get_data()\fR returns a pointer to the implementation specific custom data associated with this \s-1BIO,\s0 or \s-1NULL\s0 if none has been set. .PP -\&\fIBIO_get_init()\fR returns the state of the \s-1BIO\s0's init flag. +\&\fBBIO_get_init()\fR returns the state of the \s-1BIO\s0's init flag. .PP -\&\fIBIO_get_shutdown()\fR returns the stat of the \s-1BIO\s0's shutdown (i.e. \s-1BIO_CLOSE\s0) flag. +\&\fBBIO_get_shutdown()\fR returns the stat of the \s-1BIO\s0's shutdown (i.e. \s-1BIO_CLOSE\s0) flag. .SH "SEE ALSO" .IX Header "SEE ALSO" bio, BIO_meth_new |