xref: /freebsd/crypto/openssl/doc/man3/OSSL_PARAM_print_to_bio.pod (revision e7be843b4a162e68651d3911f0357ed464915629)
1*e7be843bSPierre Pronchery=pod
2*e7be843bSPierre Pronchery
3*e7be843bSPierre Pronchery=head1 NAME
4*e7be843bSPierre Pronchery
5*e7be843bSPierre ProncheryOSSL_PARAM_print_to_bio
6*e7be843bSPierre Pronchery- OSSL_PARAM interrogation utilities
7*e7be843bSPierre Pronchery
8*e7be843bSPierre Pronchery=head1 SYNOPSIS
9*e7be843bSPierre Pronchery
10*e7be843bSPierre Pronchery #include <openssl/params.h>
11*e7be843bSPierre Pronchery
12*e7be843bSPierre Pronchery int OSSL_PARAM_print_to_bio(const OSSL_PARAM *p, BIO *bio,
13*e7be843bSPierre Pronchery                             int print_values);
14*e7be843bSPierre Pronchery
15*e7be843bSPierre Pronchery=head1 DESCRIPTION
16*e7be843bSPierre Pronchery
17*e7be843bSPierre ProncheryOSSL_PARAM_print_to_bio() formats each parameter contained in the
18*e7be843bSPierre Proncherypassed in array of B<OSSL_PARAM> values I<p>, and prints both the key,
19*e7be843bSPierre Proncheryand optionally its value, to a provided B<BIO>.
20*e7be843bSPierre ProncheryI<p> must be a non-null array of OSSL_PARAM values, terminated
21*e7be843bSPierre Proncherywith a value containing a null I<key> member.
22*e7be843bSPierre ProncheryI<print_values> is a control parameter, indicating that key values should be
23*e7be843bSPierre Proncheryprinted, in addition to key names.
24*e7be843bSPierre Pronchery
25*e7be843bSPierre Pronchery=head1 RETURN VALUES
26*e7be843bSPierre Pronchery
27*e7be843bSPierre ProncheryOSSL_PARAM_print_to_bio() returns 1 on success, and 0 on failure
28*e7be843bSPierre Pronchery
29*e7be843bSPierre Pronchery=head1 HISTORY
30*e7be843bSPierre Pronchery
31*e7be843bSPierre ProncheryOSSL_PARAM_print_to_bio() was added in OpenSSL 3.5
32*e7be843bSPierre Pronchery
33*e7be843bSPierre Pronchery=head1 COPYRIGHT
34*e7be843bSPierre Pronchery
35*e7be843bSPierre ProncheryCopyright 2024 The OpenSSL Project Authors. All Rights Reserved.
36*e7be843bSPierre Pronchery
37*e7be843bSPierre ProncheryLicensed under the Apache License 2.0 (the "License").  You may not use
38*e7be843bSPierre Proncherythis file except in compliance with the License.  You can obtain a copy
39*e7be843bSPierre Proncheryin the file LICENSE in the source distribution or at
40*e7be843bSPierre ProncheryL<https://www.openssl.org/source/license.html>.
41*e7be843bSPierre Pronchery
42*e7be843bSPierre Pronchery=cut
43