xref: /freebsd/secure/lib/libcrypto/man/man3/BIO_new.3 (revision 2e3507c25e42292b45a5482e116d278f5515d04d)
Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)

Standard preamble:
========================================================================
..
..
.. Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

Title "BIO_NEW 3ossl"
BIO_NEW 3ossl "2023-09-19" "3.0.11" "OpenSSL"
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
"NAME"
BIO_new_ex, BIO_new, BIO_up_ref, BIO_free, BIO_vfree, BIO_free_all \- BIO allocation and freeing functions
"SYNOPSIS"
Header "SYNOPSIS" .Vb 1 #include <openssl/bio.h> \& BIO *BIO_new_ex(OSSL_LIB_CTX *libctx, const BIO_METHOD *type); BIO *BIO_new(const BIO_METHOD *type); int BIO_up_ref(BIO *a); int BIO_free(BIO *a); void BIO_vfree(BIO *a); void BIO_free_all(BIO *a); .Ve
"DESCRIPTION"
Header "DESCRIPTION" The BIO_new_ex() function returns a new \s-1BIO\s0 using method type associated with the library context libctx (see \s-1OSSL_LIB_CTX\s0\|(3)). The library context may be \s-1NULL\s0 to indicate the default library context.

The BIO_new() is the same as BIO_new_ex() except the default library context is always used.

\fBBIO_up_ref() increments the reference count associated with the \s-1BIO\s0 object.

\fBBIO_free() frees up a single \s-1BIO,\s0 BIO_vfree() also frees up a single \s-1BIO\s0 but it does not return a value. If a is \s-1NULL\s0 nothing is done. Calling BIO_free() may also have some effect on the underlying I/O structure, for example it may close the file being referred to under certain circumstances. For more details see the individual \s-1BIO_METHOD\s0 descriptions.

\fBBIO_free_all() frees up an entire \s-1BIO\s0 chain, it does not halt if an error occurs freeing up an individual \s-1BIO\s0 in the chain. If a is \s-1NULL\s0 nothing is done.

"RETURN VALUES"
Header "RETURN VALUES" \fBBIO_new_ex() and BIO_new() return a newly created \s-1BIO\s0 or \s-1NULL\s0 if the call fails.

\fBBIO_up_ref() and BIO_free() return 1 for success and 0 for failure.

\fBBIO_free_all() and BIO_vfree() do not return values.

"NOTES"
Header "NOTES" If BIO_free() is called on a \s-1BIO\s0 chain it will only free one \s-1BIO\s0 resulting in a memory leak.

Calling BIO_free_all() on a single \s-1BIO\s0 has the same effect as calling BIO_free() on it other than the discarded return value.

"HISTORY"
Header "HISTORY" \fBBIO_set() was removed in OpenSSL 1.1.0 as \s-1BIO\s0 type is now opaque.

\fBBIO_new_ex() was added in OpenSSL 3.0.

"EXAMPLES"
Header "EXAMPLES" Create a memory \s-1BIO:\s0

.Vb 1 BIO *mem = BIO_new(BIO_s_mem()); .Ve

"COPYRIGHT"
Header "COPYRIGHT" Copyright 2000-2021 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use this file except in compliance with the License. You can obtain a copy in the file \s-1LICENSE\s0 in the source distribution or at <https://www.openssl.org/source/license.html>.