summaryrefslogtreecommitdiffstats
path: root/doc/crypto/DH_new.pod
diff options
context:
space:
mode:
authorUlf Möller <ulf@openssl.org>2000-01-22 20:05:23 +0000
committerUlf Möller <ulf@openssl.org>2000-01-22 20:05:23 +0000
commit4486d0cd7a715aed7ca3728aa24413d91666bb68 (patch)
tree36342c32d8bd73c31ea5e3d33e9ee7796bab873c /doc/crypto/DH_new.pod
parent09483c58e3b21841d2761ce90b1f12b24f814881 (diff)
Document the DH library, and make some minor changes along the way.
Diffstat (limited to 'doc/crypto/DH_new.pod')
-rw-r--r--doc/crypto/DH_new.pod38
1 files changed, 38 insertions, 0 deletions
diff --git a/doc/crypto/DH_new.pod b/doc/crypto/DH_new.pod
new file mode 100644
index 0000000000..c54505af54
--- /dev/null
+++ b/doc/crypto/DH_new.pod
@@ -0,0 +1,38 @@
+=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 *rsa);
+
+=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.
+
+=head1 RETURN VALUES
+
+If the allocation fails, DH_new() returns B<NULL> and sets an error
+code that can be obtained by ERR_get_error(3). Otherwise it returns
+a pointer to the newly allocated structure.
+
+DH_free() returns no value.
+
+=head1 SEE ALSO
+
+dh(3), err(3), DH_generate_parameters(3), DH_generate_key(3)
+
+=head1 HISTORY
+
+DH_new() and DH_free() are available in all versions of SSLeay and OpenSSL.
+
+=cut