DH_new.pod 1.0 KB

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