DH_new.pod 1.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. =pod
  2. =head1 NAME
  3. DH_new, DH_free - allocate and free DH objects
  4. =head1 SYNOPSIS
  5. #include <openssl/dh.h>
  6. The following functions have been deprecated since OpenSSL 3.0, and can be
  7. hidden entirely by defining B<OPENSSL_API_COMPAT> with a suitable version value,
  8. see L<openssl_user_macros(7)>:
  9. DH* DH_new(void);
  10. void DH_free(DH *dh);
  11. =head1 DESCRIPTION
  12. DH_new() allocates and initializes a B<DH> structure.
  13. DH_free() frees the B<DH> structure and its components. The values are
  14. erased before the memory is returned to the system.
  15. If B<dh> is NULL nothing is done.
  16. =head1 RETURN VALUES
  17. If the allocation fails, DH_new() returns B<NULL> and sets an error
  18. code that can be obtained by L<ERR_get_error(3)>. Otherwise it returns
  19. a pointer to the newly allocated structure.
  20. DH_free() returns no value.
  21. =head1 SEE ALSO
  22. L<DH_new(3)>, L<ERR_get_error(3)>,
  23. L<DH_generate_parameters(3)>,
  24. L<DH_generate_key(3)>,
  25. L<EVP_PKEY-DH(7)>
  26. =head1 HISTORY
  27. All of these functions were deprecated in OpenSSL 3.0.
  28. For replacement see EVP_PKEY-DH(7).
  29. =head1 COPYRIGHT
  30. Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
  31. Licensed under the Apache License 2.0 (the "License"). You may not use
  32. this file except in compliance with the License. You can obtain a copy
  33. in the file LICENSE in the source distribution or at
  34. L<https://www.openssl.org/source/license.html>.
  35. =cut