xref: /freebsd/secure/lib/libcrypto/man/man3/BIO_find_type.3 (revision d4033e6d37747f5213bb245c8e605406703a8766)
-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)

Standard preamble:
========================================================================
..
..
.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . 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 ========================================================================

Title "BIO_FIND_TYPE 3ossl"
BIO_FIND_TYPE 3ossl 2025-09-30 3.5.4 OpenSSL
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
NAME
BIO_find_type, BIO_next, BIO_method_type - BIO chain traversal
SYNOPSIS
Header "SYNOPSIS" .Vb 1 #include <openssl/bio.h> \& BIO *BIO_find_type(BIO *b, int bio_type); BIO *BIO_next(BIO *b); int BIO_method_type(const BIO *b); .Ve
DESCRIPTION
Header "DESCRIPTION" The BIO_find_type() searches for a BIO of a given type in a chain, starting at BIO b. If type is a specific type (such as BIO_TYPE_MEM) then a search is made for a BIO of that type. If type is a general type (such as \fBBIO_TYPE_SOURCE_SINK) then the next matching BIO of the given general type is searched for. BIO_find_type() returns the next matching BIO or NULL if none is found. If type is BIO_TYPE_NONE it will not find a match.

The following general types are defined: \fBBIO_TYPE_DESCRIPTOR, BIO_TYPE_FILTER, and BIO_TYPE_SOURCE_SINK.

For a list of the specific types, see the <openssl/bio.h> header file.

\fBBIO_next() returns the next BIO in a chain. It can be used to traverse all BIOs in a chain or used in conjunction with BIO_find_type() to find all BIOs of a certain type.

\fBBIO_method_type() returns the type of a BIO.

"RETURN VALUES"
Header "RETURN VALUES" \fBBIO_find_type() returns a matching BIO or NULL for no match.

\fBBIO_next() returns the next BIO in a chain.

\fBBIO_method_type() returns the type of the BIO b.

EXAMPLES
Header "EXAMPLES" Traverse a chain looking for digest BIOs:

.Vb 1 BIO *btmp; \& btmp = in_bio; /* in_bio is chain to search through */ do { btmp = BIO_find_type(btmp, BIO_TYPE_MD); if (btmp == NULL) break; /* Not found */ /* btmp is a digest BIO, do something with it ...*/ ... \& btmp = BIO_next(btmp); } while (btmp); .Ve

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

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 in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.