DH_new.pod 872 B

12345678910111213141516171819202122232425262728293031323334353637383940
  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. =head1 RETURN VALUES
  13. If the allocation fails, DH_new() returns B<NULL> and sets an error
  14. code that can be obtained by L<ERR_get_error(3)|ERR_get_error(3)>. Otherwise it returns
  15. a pointer to the newly allocated structure.
  16. DH_free() returns no value.
  17. =head1 SEE ALSO
  18. L<dh(3)|dh(3)>, L<ERR_get_error(3)|ERR_get_error(3)>,
  19. L<DH_generate_parameters(3)|DH_generate_parameters(3)>,
  20. L<DH_generate_key(3)|DH_generate_key(3)>
  21. =head1 HISTORY
  22. DH_new() and DH_free() are available in all versions of SSLeay and OpenSSL.
  23. =cut