xref: /netbsd-src/crypto/external/bsd/openssl.old/dist/doc/man3/DH_new.pod (revision 4724848cf0da353df257f730694b7882798e5daf)
1*4724848cSchristos=pod
2*4724848cSchristos
3*4724848cSchristos=head1 NAME
4*4724848cSchristos
5*4724848cSchristosDH_new, DH_free - allocate and free DH objects
6*4724848cSchristos
7*4724848cSchristos=head1 SYNOPSIS
8*4724848cSchristos
9*4724848cSchristos #include <openssl/dh.h>
10*4724848cSchristos
11*4724848cSchristos DH* DH_new(void);
12*4724848cSchristos
13*4724848cSchristos void DH_free(DH *dh);
14*4724848cSchristos
15*4724848cSchristos=head1 DESCRIPTION
16*4724848cSchristos
17*4724848cSchristosDH_new() allocates and initializes a B<DH> structure.
18*4724848cSchristos
19*4724848cSchristosDH_free() frees the B<DH> structure and its components. The values are
20*4724848cSchristoserased before the memory is returned to the system.
21*4724848cSchristosIf B<dh> is NULL nothing is done.
22*4724848cSchristos
23*4724848cSchristos=head1 RETURN VALUES
24*4724848cSchristos
25*4724848cSchristosIf the allocation fails, DH_new() returns B<NULL> and sets an error
26*4724848cSchristoscode that can be obtained by L<ERR_get_error(3)>. Otherwise it returns
27*4724848cSchristosa pointer to the newly allocated structure.
28*4724848cSchristos
29*4724848cSchristosDH_free() returns no value.
30*4724848cSchristos
31*4724848cSchristos=head1 SEE ALSO
32*4724848cSchristos
33*4724848cSchristosL<DH_new(3)>, L<ERR_get_error(3)>,
34*4724848cSchristosL<DH_generate_parameters(3)>,
35*4724848cSchristosL<DH_generate_key(3)>
36*4724848cSchristos
37*4724848cSchristos=head1 COPYRIGHT
38*4724848cSchristos
39*4724848cSchristosCopyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
40*4724848cSchristos
41*4724848cSchristosLicensed under the OpenSSL license (the "License").  You may not use
42*4724848cSchristosthis file except in compliance with the License.  You can obtain a copy
43*4724848cSchristosin the file LICENSE in the source distribution or at
44*4724848cSchristosL<https://www.openssl.org/source/license.html>.
45*4724848cSchristos
46*4724848cSchristos=cut
47