1BIO_F_PREFIX(3ossl)                 OpenSSL                BIO_F_PREFIX(3ossl)
2
3
4

NAME

6       BIO_f_prefix, BIO_set_prefix, BIO_set_indent, BIO_get_indent - prefix
7       BIO filter
8

SYNOPSIS

10        #include <openssl/bio.h>
11
12        const BIO_METHOD *BIO_f_prefix(void);
13        long BIO_set_prefix(BIO *b, const char *prefix);
14        long BIO_set_indent(BIO *b, long indent);
15        long BIO_get_indent(BIO *b);
16

DESCRIPTION

18       BIO_f_cipher() returns the prefix BIO method. This is a filter for text
19       output, where each line gets automatically prefixed and indented
20       according to user input.
21
22       The prefix and the indentation are combined.  For each line of output
23       going through this filter, the prefix is output first, then the amount
24       of additional spaces indicated by the indentation, and then the line
25       itself.
26
27       By default, there is no prefix, and indentation is set to 0.
28
29       BIO_set_prefix() sets the prefix to be used for future lines of text,
30       using prefix.  prefix may be NULL, signifying that there should be no
31       prefix.  If prefix isn't NULL, this function makes a copy of it.
32
33       BIO_set_indent() sets the indentation to be used for future lines of
34       text, using indent.  Negative values are not allowed.
35
36       BIO_get_indent() gets the current indentation.
37

NOTES

39       BIO_set_prefix(), BIO_set_indent() and BIO_get_indent() are implemented
40       as macros.
41

RETURN VALUES

43       BIO_f_prefix() returns the prefix BIO method.
44
45       BIO_set_prefix() returns 1 if the prefix was correctly set, or <=0 on
46       failure.
47
48       BIO_set_indent() returns 1 if the prefix was correctly set, or <=0 on
49       failure.
50
51       BIO_get_indent() returns the current indentation, or a negative value
52       for failure.
53

SEE ALSO

55       bio(7)
56

58       Copyright 2019-2021 The OpenSSL Project Authors. All Rights Reserved.
59
60       Licensed under the Apache License 2.0 (the "License").  You may not use
61       this file except in compliance with the License.  You can obtain a copy
62       in the file LICENSE in the source distribution or at
63       <https://www.openssl.org/source/license.html>.
64
65
66
673.1.1                             2023-08-31               BIO_F_PREFIX(3ossl)
Impressum