Debian Codegraph @

upstream/debian-unstable/man3/BIO_printf.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "BIO_PRINTF 3SSL"
58 .TH BIO_PRINTF 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 BIO_printf, BIO_vprintf, BIO_snprintf, BIO_vsnprintf
65 \&\- formatted output to a BIO
66 .SH SYNOPSIS
67 .IX Header "SYNOPSIS"
68 .Vb 1
69 \& #include <openssl/bio.h>
70 \&
71 \& int BIO_printf(BIO *bio, const char *format, ...);
72 \& int BIO_vprintf(BIO *bio, const char *format, va_list args);
73 \&
74 \& int BIO_snprintf(char *buf, size_t n, const char *format, ...);
75 \& int BIO_vsnprintf(char *buf, size_t n, const char *format, va_list args);
76 .Ve
77 .SH DESCRIPTION
78 .IX Header "DESCRIPTION"
79 \&\fBBIO_printf()\fR is similar to the standard C \fBprintf()\fR function, except that
80 the output is sent to the specified BIO, \fIbio\fR, rather than standard
81 output. All common format specifiers are supported.
82 .PP
83 \&\fBBIO_vprintf()\fR is similar to the \fBvprintf()\fR function found on many platforms,
84 the output is sent to the specified BIO, \fIbio\fR, rather than standard
85 output. All common format specifiers are supported. The argument
86 list \fIargs\fR is a stdarg argument list.
87 .PP
88 \&\fBBIO_snprintf()\fR is for platforms that do not have the common \fBsnprintf()\fR
89 function. It is like \fBsprintf()\fR except that the size parameter, \fIn\fR,
90 specifies the size of the output buffer.
91 .PP
92 \&\fBBIO_vsnprintf()\fR is to \fBBIO_snprintf()\fR as \fBBIO_vprintf()\fR is to \fBBIO_printf()\fR.
93 .SH "RETURN VALUES"
94 .IX Header "RETURN VALUES"
95 All functions return the number of bytes written, or \-1 on error.
96 For \fBBIO_snprintf()\fR and \fBBIO_vsnprintf()\fR this includes when the output
97 buffer is too small.
98 .SH NOTES
99 .IX Header "NOTES"
100 Except when \fIn\fR is 0, both \fBBIO_snprintf()\fR and \fBBIO_vsnprintf()\fR always
101 terminate their output with \f(CW\*(Aq\e0\*(Aq\fR. This includes cases where \-1 is
102 returned, such as when there is insufficient space to output the whole
103 string.
104 .SH COPYRIGHT
105 .IX Header "COPYRIGHT"
106 Copyright 2017\-2021 The OpenSSL Project Authors. All Rights Reserved.
107 .PP
108 Licensed under the Apache License 2.0 (the "License"). You may not use
109 this file except in compliance with the License. You can obtain a copy
110 in the file LICENSE in the source distribution or at
111 <https://www.openssl.org/source/license.html>.