doc/crypto/BN_CTX_start.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 BN_CTX_start, BN_CTX_get, BN_CTX_end - use temporary BIGNUM variables
   6
   7 =head1 SYNOPSIS
   8
   9  #include <openssl/bn.h>
  10
  11  void BN_CTX_start(BN_CTX *ctx);
  12
  13  BIGNUM *BN_CTX_get(BN_CTX *ctx);
  14
  15  void BN_CTX_end(BN_CTX *ctx);
  16
  17 =head1 DESCRIPTION
  18
  19 These functions are used to obtain temporary B<BIGNUM> variables from
  20 a B<BN_CTX> (which can been created by using L<BN_CTX_new(3)>)
  21 in order to save the overhead of repeatedly creating and
  22 freeing B<BIGNUM>s in functions that are called from inside a loop.
  23
  24 A function must call BN_CTX_start() first. Then, BN_CTX_get() may be
  25 called repeatedly to obtain temporary B<BIGNUM>s. All BN_CTX_get()
  26 calls must be made before calling any other functions that use the
  27 B<ctx> as an argument.
  28
  29 Finally, BN_CTX_end() must be called before returning from the function.
  30 When BN_CTX_end() is called, the B<BIGNUM> pointers obtained from
  31 BN_CTX_get() become invalid.
  32
  33 =head1 RETURN VALUES
  34
  35 BN_CTX_start() and BN_CTX_end() return no values.
  36
  37 BN_CTX_get() returns a pointer to the B<BIGNUM>, or B<NULL> on error.
  38 Once BN_CTX_get() has failed, the subsequent calls will return B<NULL>
  39 as well, so it is sufficient to check the return value of the last
  40 BN_CTX_get() call. In case of an error, an error code is set, which
  41 can be obtained by L<ERR_get_error(3)>.
  42
  43
  44 =head1 SEE ALSO
  45
  46 L<BN_CTX_new(3)>
  47
  48 =cut
  49
  50 =head1 COPYRIGHT
  51
  52 Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
  53
  54 Licensed under the OpenSSL license (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