summaryrefslogtreecommitdiffstats
path: root/doc/crypto/BN_copy.pod
diff options
context:
space:
mode:
authorUlf Möller <ulf@openssl.org>2000-01-23 22:06:24 +0000
committerUlf Möller <ulf@openssl.org>2000-01-23 22:06:24 +0000
commitdd8dec69b825c9fdafc26a200961702d850496b5 (patch)
treeb7d7ca7365271c822226e1ddc6a4fd68c72273ad /doc/crypto/BN_copy.pod
parentce052b6c3b18d4ab5f74990d82d09827a6014823 (diff)
Document the BN library.
Diffstat (limited to 'doc/crypto/BN_copy.pod')
-rw-r--r--doc/crypto/BN_copy.pod34
1 files changed, 34 insertions, 0 deletions
diff --git a/doc/crypto/BN_copy.pod b/doc/crypto/BN_copy.pod
new file mode 100644
index 0000000000..9766adcc5a
--- /dev/null
+++ b/doc/crypto/BN_copy.pod
@@ -0,0 +1,34 @@
+=pod
+
+=head1 NAME
+
+BN_copy, BN_dup - copy BIGNUMs
+
+=head1 SYNOPSIS
+
+ #include <openssl/bn.h>
+
+ BIGNUM *BN_copy(BIGNUM *to, const BIGNUM *from);
+
+ BIGNUM *BN_dup(const BIGNUM *from);
+
+=head1 DESCRIPTION
+
+BN_copy() copies B<from> to B<to>. BN_dup() creates a new B<BIGNUM>
+containing the value B<from>.
+
+=head1 RETURN VALUES
+
+BN_copy() returns B<to> on success, NULL on error. BN_dup() returns
+the new B<BIGNUM>, and NULL on error. The error codes can be obtained
+by ERR_get_error(3).
+
+=head1 SEE ALSO
+
+bn(3), err(3)
+
+=head1 HISTORY
+
+BN_copy() and BN_dup() are available in all versions of SSLeay and OpenSSL.
+
+=cut