BIO_f_prefix.pod 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970
  1. =pod
  2. =head1 NAME
  3. BIO_f_prefix, BIO_set_prefix, BIO_set_indent, BIO_get_indent
  4. - prefix BIO filter
  5. =head1 SYNOPSIS
  6. #include <openssl/bio.h>
  7. const BIO_METHOD *BIO_f_prefix(void);
  8. long BIO_set_prefix(BIO *b, const char *prefix);
  9. long BIO_set_indent(BIO *b, long indent);
  10. long BIO_get_indent(BIO *b);
  11. =head1 DESCRIPTION
  12. BIO_f_cipher() returns the prefix BIO method. This is a filter for
  13. text output, where each line gets automatically prefixed and indented
  14. according to user input.
  15. The prefix and the indentation are combined. For each line of output
  16. going through this filter, the prefix is output first, then the amount
  17. of additional spaces indicated by the indentation, and then the line
  18. itself.
  19. By default, there is no prefix, and indentation is set to 0.
  20. BIO_set_prefix() sets the prefix to be used for future lines of
  21. text, using I<prefix>. I<prefix> may be NULL, signifying that there
  22. should be no prefix. If I<prefix> isn't NULL, this function makes a
  23. copy of it.
  24. BIO_set_indent() sets the indentation to be used for future lines of
  25. text, using I<indent>. Negative values are not allowed.
  26. BIO_get_indent() gets the current indentation.
  27. =head1 NOTES
  28. BIO_set_prefix(), BIO_set_indent() and BIO_get_indent() are
  29. implemented as macros.
  30. =head1 RETURN VALUES
  31. BIO_f_prefix() returns the prefix BIO method.
  32. BIO_set_prefix() returns 1 if the prefix was correctly set, or 0 on
  33. failure.
  34. BIO_set_indent() returns 1 if the prefix was correctly set, or 0 on
  35. failure.
  36. BIO_get_indent() returns the current indentation.
  37. =head1 SEE ALSO
  38. L<bio(7)>
  39. =head1 COPYRIGHT
  40. Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
  41. Licensed under the Apache License 2.0 (the "License"). You may not use
  42. this file except in compliance with the License. You can obtain a copy
  43. in the file LICENSE in the source distribution or at
  44. L<https://www.openssl.org/source/license.html>.
  45. =cut