OSSL_PARAM_PRINT_TO_BIO(3ossl)

πŸ“¦
version 15.1 Β· 2 versions
, in freebsd 15.1

πŸ’… OSSL_PARAM_PRINT_TO_BIO πŸ’…

okay bestie, so this one is from the OpenSSL fam β€” it lives in manual section 3ossl, and it's literally the glow-up guide for OSSL_PARAM_print_to_bio. it's short, it's sweet, and it's gonna eat, i promise 🫢


✨ NAME ✨

OSSL_PARAM_print_to_bio β€” the OSSL_PARAM interrogation utilities, aka the little function that spills the tea on your params πŸ”


🌸 SYNOPSIS 🌸

#include <openssl/params.h>

int OSSL_PARAM_print_to_bio(const OSSL_PARAM *p, BIO *bio,
                            int print_values);

πŸ¦‹ DESCRIPTION πŸ¦‹

okay so picture this: you hand OSSL_PARAM_print_to_bio() an array of OSSL_PARAM values in p, and it formats every single parameter in there and prints the key β€” and, if you want, the value too β€” out to a BIO you provide. iconic behaviour honestly πŸ’…

a couple of ground rules so nothing gets weird:

  • p must be a non-null array of OSSL_PARAM values.
  • that array has to be terminated with a value that contains a null key member. no cap, that's how it knows where to stop πŸ›‘
  • print_values is the control parameter β€” it's the little switch that says whether key values get printed in addition to the key names. set it and you get the whole picture; leave it off and it's names only ✨

πŸ’– RETURN VALUES πŸ’–

  • OSSL_PARAM_print_to_bio() returns 1 on success πŸŽ‰
  • and 0 on failure 😭

🌈 HISTORY 🌈

OSSL_PARAM_print_to_bio() was added in OpenSSL 3.5 β€” so it's new-new, fresh out the box πŸŽ€


Copyright 2024 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>.

fr fr bestie, read the license before you go copying stuff β€” it's giving legally binding and we respect that πŸ’€

and that's the whole page 🧚 toodles! this was 3.5.6, dated 2026-04-07, and the man page answer to the name OSSL_PARAM_PRINT_TO_BIO(3ossl) β€” slay, goodbye, mwah πŸ’œ

πŸ“¦ where this page comes from