$NetBSD: BIO_f_prefix.3,v 1.5 2024/09/08 13:08:15 christos Exp $

-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

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_f_prefix 3" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
BIO_f_prefix, BIO_set_prefix, BIO_set_indent, BIO_get_indent \- prefix BIO filter Header "SYNOPSIS" .Vb 1 #include <openssl/bio.h> \& const BIO_METHOD *BIO_f_prefix(void); long BIO_set_prefix(BIO *b, const char *prefix); long BIO_set_indent(BIO *b, long indent); long BIO_get_indent(BIO *b); .Ve Header "DESCRIPTION" \fBBIO_f_cipher() returns the prefix BIO method. This is a filter for text output, where each line gets automatically prefixed and indented according to user input.

The prefix and the indentation are combined. For each line of output going through this filter, the prefix is output first, then the amount of additional spaces indicated by the indentation, and then the line itself.

By default, there is no prefix, and indentation is set to 0.

\fBBIO_set_prefix() sets the prefix to be used for future lines of text, using prefix. prefix may be NULL, signifying that there should be no prefix. If prefix isn't NULL, this function makes a copy of it.

\fBBIO_set_indent() sets the indentation to be used for future lines of text, using indent. Negative values are not allowed.

\fBBIO_get_indent() gets the current indentation.

Header "NOTES" \fBBIO_set_prefix(), BIO_set_indent() and BIO_get_indent() are implemented as macros. Header "RETURN VALUES" \fBBIO_f_prefix() returns the prefix BIO method.

\fBBIO_set_prefix() returns 1 if the prefix was correctly set, or <=0 on failure.

\fBBIO_set_indent() returns 1 if the prefix was correctly set, or <=0 on failure.

\fBBIO_get_indent() returns the current indentation, or a negative value for failure.

Header "SEE ALSO" \fBbio\|(7) Header "COPYRIGHT" Copyright 2019-2021 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>.