$NetBSD: BIO_printf.3,v 1.9 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_printf 3" For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
BIO_printf, BIO_vprintf, BIO_snprintf, BIO_vsnprintf \- formatted output to a BIO Header "SYNOPSIS" .Vb 1 #include <openssl/bio.h> \& int BIO_printf(BIO *bio, const char *format, ...); int BIO_vprintf(BIO *bio, const char *format, va_list args); \& int BIO_snprintf(char *buf, size_t n, const char *format, ...); int BIO_vsnprintf(char *buf, size_t n, const char *format, va_list args); .Ve Header "DESCRIPTION" \fBBIO_printf() is similar to the standard C printf() function, except that the output is sent to the specified BIO, bio, rather than standard output. All common format specifiers are supported.

\fBBIO_vprintf() is similar to the vprintf() function found on many platforms, the output is sent to the specified BIO, bio, rather than standard output. All common format specifiers are supported. The argument list args is a stdarg argument list.

\fBBIO_snprintf() is for platforms that do not have the common snprintf() function. It is like sprintf() except that the size parameter, n, specifies the size of the output buffer.

\fBBIO_vsnprintf() is to BIO_snprintf() as BIO_vprintf() is to BIO_printf().

Header "RETURN VALUES" All functions return the number of bytes written, or -1 on error. For BIO_snprintf() and BIO_vsnprintf() this includes when the output buffer is too small. Header "NOTES" Except when n is 0, both BIO_snprintf() and BIO_vsnprintf() always terminate their output with \*(Aq\e0\*(Aq. This includes cases where -1 is returned, such as when there is insufficient space to output the whole string. Header "COPYRIGHT" Copyright 2017-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>.