xref: /onnv-gate/usr/src/common/openssl/doc/crypto/DH_new.pod (revision 2175:b0b2f052a486)
1*2175Sjp161948=pod
2*2175Sjp161948
3*2175Sjp161948=head1 NAME
4*2175Sjp161948
5*2175Sjp161948DH_new, DH_free - allocate and free DH objects
6*2175Sjp161948
7*2175Sjp161948=head1 SYNOPSIS
8*2175Sjp161948
9*2175Sjp161948 #include <openssl/dh.h>
10*2175Sjp161948
11*2175Sjp161948 DH* DH_new(void);
12*2175Sjp161948
13*2175Sjp161948 void DH_free(DH *dh);
14*2175Sjp161948
15*2175Sjp161948=head1 DESCRIPTION
16*2175Sjp161948
17*2175Sjp161948DH_new() allocates and initializes a B<DH> structure.
18*2175Sjp161948
19*2175Sjp161948DH_free() frees the B<DH> structure and its components. The values are
20*2175Sjp161948erased before the memory is returned to the system.
21*2175Sjp161948
22*2175Sjp161948=head1 RETURN VALUES
23*2175Sjp161948
24*2175Sjp161948If the allocation fails, DH_new() returns B<NULL> and sets an error
25*2175Sjp161948code that can be obtained by L<ERR_get_error(3)|ERR_get_error(3)>. Otherwise it returns
26*2175Sjp161948a pointer to the newly allocated structure.
27*2175Sjp161948
28*2175Sjp161948DH_free() returns no value.
29*2175Sjp161948
30*2175Sjp161948=head1 SEE ALSO
31*2175Sjp161948
32*2175Sjp161948L<dh(3)|dh(3)>, L<ERR_get_error(3)|ERR_get_error(3)>,
33*2175Sjp161948L<DH_generate_parameters(3)|DH_generate_parameters(3)>,
34*2175Sjp161948L<DH_generate_key(3)|DH_generate_key(3)>
35*2175Sjp161948
36*2175Sjp161948=head1 HISTORY
37*2175Sjp161948
38*2175Sjp161948DH_new() and DH_free() are available in all versions of SSLeay and OpenSSL.
39*2175Sjp161948
40*2175Sjp161948=cut
41