projects / thirdparty / openssl.git / blame
| Commit | Line | Data |
|---|---|---|
| 4486d0cd UM |
1 | =pod |
| 2 | ||
| 3 | =head1 NAME | |
| 4 | ||
| 5 | DH_new, DH_free - allocate and free DH objects | |
| 6 | ||
| 7 | =head1 SYNOPSIS | |
| 8 | ||
| 9 | #include <openssl/dh.h> | |
| 10 | ||
| 11 | DH* DH_new(void); | |
| 12 | ||
| 38e33cef | 13 | void DH_free(DH *dh); |
| 4486d0cd UM |
14 | |
| 15 | =head1 DESCRIPTION | |
| 16 | ||
| 17 | DH_new() allocates and initializes a B<DH> structure. | |
| 18 | ||
| 19 | DH_free() frees the B<DH> structure and its components. The values are | |
| 20 | erased before the memory is returned to the system. | |
| d6407083 | 21 | If B<dh> is NULL nothing is done. |
| 4486d0cd UM |
22 | |
| 23 | =head1 RETURN VALUES | |
| 24 | ||
| 25 | If the allocation fails, DH_new() returns B<NULL> and sets an error | |
| 9b86974e | 26 | code that can be obtained by L<ERR_get_error(3)>. Otherwise it returns |
| 4486d0cd UM |
27 | a pointer to the newly allocated structure. |
| 28 | ||
| 29 | DH_free() returns no value. | |
| 30 | ||
| 31 | =head1 SEE ALSO | |
| 32 | ||
| b97fdb57 | 33 | L<DH_new(3)>, L<ERR_get_error(3)>, |
| 9b86974e RS |
34 | L<DH_generate_parameters(3)>, |
| 35 | L<DH_generate_key(3)> | |
| 4486d0cd | 36 | |
| e2f92610 RS |
37 | =head1 COPYRIGHT |
| 38 | ||
| 39 | Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved. | |
| 40 | ||
| 4746f25a | 41 | Licensed under the Apache License 2.0 (the "License"). You may not use |
| e2f92610 RS |
42 | this file except in compliance with the License. You can obtain a copy |
| 43 | in the file LICENSE in the source distribution or at | |
| 44 | L<https://www.openssl.org/source/license.html>. | |
| 45 | ||
| 46 | =cut |