4746f25ac6
[skip ci] Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/7829)
46 lines
1 KiB
Text
46 lines
1 KiB
Text
=pod
|
|
|
|
=head1 NAME
|
|
|
|
DH_new, DH_free - allocate and free DH objects
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
#include <openssl/dh.h>
|
|
|
|
DH* DH_new(void);
|
|
|
|
void DH_free(DH *dh);
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
DH_new() allocates and initializes a B<DH> structure.
|
|
|
|
DH_free() frees the B<DH> structure and its components. The values are
|
|
erased before the memory is returned to the system.
|
|
If B<dh> is NULL nothing is done.
|
|
|
|
=head1 RETURN VALUES
|
|
|
|
If the allocation fails, DH_new() returns B<NULL> and sets an error
|
|
code that can be obtained by L<ERR_get_error(3)>. Otherwise it returns
|
|
a pointer to the newly allocated structure.
|
|
|
|
DH_free() returns no value.
|
|
|
|
=head1 SEE ALSO
|
|
|
|
L<DH_new(3)>, L<ERR_get_error(3)>,
|
|
L<DH_generate_parameters(3)>,
|
|
L<DH_generate_key(3)>
|
|
|
|
=head1 COPYRIGHT
|
|
|
|
Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
|
|
|
|
Licensed under the Apache License 2.0 (the "License"). You may not use
|
|
this file except in compliance with the License. You can obtain a copy
|
|
in the file LICENSE in the source distribution or at
|
|
L<https://www.openssl.org/source/license.html>.
|
|
|
|
=cut
|