doc/man3/OSSL_ENCODER_to_bio.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 OSSL_ENCODER_to_bio,
   6 OSSL_ENCODER_to_fp
   7 - Encoder file output routines
   8
   9 =head1 SYNOPSIS
  10
  11  #include <openssl/encoder.h>
  12
  13  int OSSL_ENCODER_to_bio(OSSL_ENCODER_CTX *ctx, BIO *out);
  14  int OSSL_ENCODER_to_fp(OSSL_ENCODER_CTX *ctx, FILE *fp);
  15
  16 Feature availability macros:
  17
  18 =over 4
  19
  20 =item OSSL_ENCODER_to_fp() is only available when B<OPENSSL_NO_STDIO>
  21 is undefined.
  22
  23 =back
  24
  25 =head1 DESCRIPTION
  26
  27 OSSL_ENCODER_to_bio() runs the encoding process for the
  28 context I<ctx>, with the output going to the B<BIO> I<out>.  The
  29 application is required to set up the B<BIO> properly, for example to
  30 have it in text or binary mode if that's appropriate.
  31
  32 =for comment Know your encoder!
  33
  34 OSSL_ENCODER_to_fp() does the same thing as OSSL_ENCODER_to_bio(),
  35 except that the output is going to the B<FILE> I<fp>.
  36
  37 =head1 RETURN VALUES
  38
  39 OSSL_ENCODER_to_bio() and OSSL_ENCODER_to_fp() return 1 on
  40 success, or 0 on failure.
  41
  42 =head1 SEE ALSO
  43
  44 L<provider(7)>, L<OSSL_ENCODER_CTX(3)>
  45
  46 =head1 HISTORY
  47
  48 The functions described here were added in OpenSSL 3.0.
  49
  50 =head1 COPYRIGHT
  51
  52 Copyright 2019 The OpenSSL Project Authors. All Rights Reserved.
  53
  54 Licensed under the Apache License 2.0 (the "License").  You may not use
  55 this file except in compliance with the License.  You can obtain a copy
  56 in the file LICENSE in the source distribution or at
  57 L<https://www.openssl.org/source/license.html>.
  58
  59 =cut