Update documentation following BN opaquify
[openssl.git] / doc / crypto / BN_CTX_new.pod
1 =pod
2
3 =head1 NAME
4
5 BN_CTX_new, BN_CTX_init, BN_CTX_free - allocate and free BN_CTX structures
6
7 =head1 SYNOPSIS
8
9  #include <openssl/bn.h>
10
11  BN_CTX *BN_CTX_new(void);
12
13  void BN_CTX_free(BN_CTX *c);
14
15 =head1 DESCRIPTION
16
17 A B<BN_CTX> is a structure that holds B<BIGNUM> temporary variables used by
18 library functions. Since dynamic memory allocation to create B<BIGNUM>s
19 is rather expensive when used in conjunction with repeated subroutine
20 calls, the B<BN_CTX> structure is used.
21
22 BN_CTX_new() allocates and initializes a B<BN_CTX>
23 structure. 
24
25 BN_CTX_free() frees the components of the B<BN_CTX>, and if it was
26 created by BN_CTX_new(), also the structure itself.
27 If L<BN_CTX_start(3)|BN_CTX_start(3)> has been used on the B<BN_CTX>,
28 L<BN_CTX_end(3)|BN_CTX_end(3)> must be called before the B<BN_CTX>
29 may be freed by BN_CTX_free().
30
31 =head1 RETURN VALUES
32
33 BN_CTX_new() returns a pointer to the B<BN_CTX>. If the allocation fails,
34 it returns B<NULL> and sets an error code that can be obtained by
35 L<ERR_get_error(3)|ERR_get_error(3)>.
36
37 BN_CTX_free() has no return values.
38
39 =head1 REMOVED FUNCTIONALITY
40
41  void BN_CTX_init(BN_CTX *c);
42
43 BN_CTX_init() is no longer available as of OpenSSL 1.1.0. Applications should
44 replace use of BN_CTX_init with BN_CTX_new instead:
45
46  BN_CTX *ctx;
47  ctx = BN_CTX_new();
48  if(!ctx) /* Handle error */
49  ...
50  BN_CTX_free(ctx);
51
52 =head1 SEE ALSO
53
54 L<bn(3)|bn(3)>, L<ERR_get_error(3)|ERR_get_error(3)>, L<BN_add(3)|BN_add(3)>,
55 L<BN_CTX_start(3)|BN_CTX_start(3)>
56
57 =head1 HISTORY
58
59 BN_CTX_new() and BN_CTX_free() are available in all versions on SSLeay
60 and OpenSSL. BN_CTX_init() was added in SSLeay 0.9.1b and removed in OpenSSL
61 1.1.0.
62
63 =cut