release/src/router/openssl/doc/crypto/DH_new.pod

   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
  13  void DH_free(DH *dh);
  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.
  21
  22 =head1 RETURN VALUES
  23
  24 If the allocation fails, DH_new() returns B<NULL> and sets an error
  25 code that can be obtained by L<ERR_get_error(3)|ERR_get_error(3)>. Otherwise it returns
  26 a pointer to the newly allocated structure.
  27
  28 DH_free() returns no value.
  29
  30 =head1 SEE ALSO
  31
  32 L<dh(3)|dh(3)>, L<ERR_get_error(3)|ERR_get_error(3)>,
  33 L<DH_generate_parameters(3)|DH_generate_parameters(3)>,
  34 L<DH_generate_key(3)|DH_generate_key(3)>
  35
  36 =head1 HISTORY
  37
  38 DH_new() and DH_free() are available in all versions of SSLeay and OpenSSL.
  39
  40 =cut