xref: /netbsd-src/crypto/external/bsd/openssl.old/dist/doc/man3/BIO_printf.pod (revision 4724848cf0da353df257f730694b7882798e5daf)
1*4724848cSchristos=pod
2*4724848cSchristos
3*4724848cSchristos=head1 NAME
4*4724848cSchristos
5*4724848cSchristosBIO_printf, BIO_vprintf, BIO_snprintf, BIO_vsnprintf
6*4724848cSchristos- formatted output to a BIO
7*4724848cSchristos
8*4724848cSchristos=head1 SYNOPSIS
9*4724848cSchristos
10*4724848cSchristos #include <openssl/bio.h>
11*4724848cSchristos
12*4724848cSchristos int BIO_printf(BIO *bio, const char *format, ...)
13*4724848cSchristos int BIO_vprintf(BIO *bio, const char *format, va_list args)
14*4724848cSchristos
15*4724848cSchristos int BIO_snprintf(char *buf, size_t n, const char *format, ...)
16*4724848cSchristos int BIO_vsnprintf(char *buf, size_t n, const char *format, va_list args)
17*4724848cSchristos
18*4724848cSchristos=head1 DESCRIPTION
19*4724848cSchristos
20*4724848cSchristosBIO_printf() is similar to the standard C printf() function, except that
21*4724848cSchristosthe output is sent to the specified BIO, B<bio>, rather than standard
22*4724848cSchristosoutput.  All common format specifiers are supported.
23*4724848cSchristos
24*4724848cSchristosBIO_vprintf() is similar to the vprintf() function found on many platforms,
25*4724848cSchristosthe output is sent to the specified BIO, B<bio>, rather than standard
26*4724848cSchristosoutput.  All common format specifiers are supported. The argument
27*4724848cSchristoslist B<args> is a stdarg argument list.
28*4724848cSchristos
29*4724848cSchristosBIO_snprintf() is for platforms that do not have the common snprintf()
30*4724848cSchristosfunction. It is like sprintf() except that the size parameter, B<n>,
31*4724848cSchristosspecifies the size of the output buffer.
32*4724848cSchristos
33*4724848cSchristosBIO_vsnprintf() is to BIO_snprintf() as BIO_vprintf() is to BIO_printf().
34*4724848cSchristos
35*4724848cSchristos=head1 RETURN VALUES
36*4724848cSchristos
37*4724848cSchristosAll functions return the number of bytes written, or -1 on error.
38*4724848cSchristosFor BIO_snprintf() and BIO_vsnprintf() this includes when the output
39*4724848cSchristosbuffer is too small.
40*4724848cSchristos
41*4724848cSchristos=head1 COPYRIGHT
42*4724848cSchristos
43*4724848cSchristosCopyright 2017 The OpenSSL Project Authors. All Rights Reserved.
44*4724848cSchristos
45*4724848cSchristosLicensed under the OpenSSL license (the "License").  You may not use
46*4724848cSchristosthis file except in compliance with the License.  You can obtain a copy
47*4724848cSchristosin the file LICENSE in the source distribution or at
48*4724848cSchristosL<https://www.openssl.org/source/license.html>.
49*4724848cSchristos
50*4724848cSchristos=cut
51