diff options
Diffstat (limited to 'secure/lib/libcrypto/man/man3/BIO_get_data.3')
| -rw-r--r-- | secure/lib/libcrypto/man/man3/BIO_get_data.3 | 25 |
1 files changed, 17 insertions, 8 deletions
diff --git a/secure/lib/libcrypto/man/man3/BIO_get_data.3 b/secure/lib/libcrypto/man/man3/BIO_get_data.3 index a0a98acad594..528f79be729f 100644 --- a/secure/lib/libcrypto/man/man3/BIO_get_data.3 +++ b/secure/lib/libcrypto/man/man3/BIO_get_data.3 @@ -1,5 +1,5 @@ .\" -*- mode: troff; coding: utf-8 -*- -.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) +.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45) .\" .\" Standard preamble: .\" ======================================================================== @@ -52,10 +52,13 @@ . \} .\} .rr rF +.\" +.\" Required to disable full justification in groff 1.23.0. +.if n .ds AD l .\" ======================================================================== .\" .IX Title "BIO_GET_DATA 3ossl" -.TH BIO_GET_DATA 3ossl 2025-09-30 3.5.4 OpenSSL +.TH BIO_GET_DATA 3ossl 2026-04-07 3.5.6 OpenSSL .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -77,13 +80,13 @@ BIO_get_shutdown \- functions for managing BIO state information .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" -These functions are mainly useful when implementing a custom BIO. +These functions can be used when implementing a custom BIO. .PP The \fBBIO_set_data()\fR function associates the custom data pointed to by \fBptr\fR with the BIO. 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 \fBBIO_set_init()\fR function sets the value of the BIO's "init" flag to indicate +The \fBBIO_set_init()\fR function sets the value of the BIO\*(Aqs "init" flag to indicate whether initialisation has been completed for this BIO or not. A nonzero value indicates that initialisation is complete, whilst zero indicates that it is not. Often initialisation will complete during initial construction of the BIO. For @@ -92,16 +95,22 @@ have occurred (for example through calling custom ctrls). The \fBBIO_get_init()\ function returns the value of the "init" flag. .PP The \fBBIO_set_shutdown()\fR and \fBBIO_get_shutdown()\fR functions set and get the state of -this BIO's shutdown (i.e. BIO_CLOSE) flag. If set then the underlying resource +this BIO\*(Aqs shutdown (i.e. BIO_CLOSE) flag. If set then the underlying resource is also closed when the BIO is freed. +.SH WARNINGS +.IX Header "WARNINGS" +Do not use \fBBIO_set_data()\fR, \fBBIO_get_data()\fR, \fBBIO_set_init()\fR, \fBBIO_get_init()\fR, outside +the implementation of a custom BIO. +Calling \fBBIO_set_data()\fR on an existing BIO implementation with data that it does +not expect will lead to unexpected results. .SH "RETURN VALUES" .IX Header "RETURN VALUES" \&\fBBIO_get_data()\fR returns a pointer to the implementation specific custom data associated with this BIO, or NULL if none has been set. .PP -\&\fBBIO_get_init()\fR returns the state of the BIO's init flag. +\&\fBBIO_get_init()\fR returns the state of the BIO\*(Aqs init flag. .PP -\&\fBBIO_get_shutdown()\fR returns the stat of the BIO's shutdown (i.e. BIO_CLOSE) flag. +\&\fBBIO_get_shutdown()\fR returns the stat of the BIO\*(Aqs shutdown (i.e. BIO_CLOSE) flag. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBbio\fR\|(7), \fBBIO_meth_new\fR\|(3) @@ -110,7 +119,7 @@ associated with this BIO, or NULL if none has been set. The functions described here were added in OpenSSL 1.1.0. .SH COPYRIGHT .IX Header "COPYRIGHT" -Copyright 2016 The OpenSSL Project Authors. All Rights Reserved. +Copyright 2016\-2026 The OpenSSL Project Authors. All Rights Reserved. .PP Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy |