summaryrefslogtreecommitdiffstats
path: root/doc/crypto/BN_num_bytes.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_num_bytes.pod
parentce052b6c3b18d4ab5f74990d82d09827a6014823 (diff)
Document the BN library.
Diffstat (limited to 'doc/crypto/BN_num_bytes.pod')
-rw-r--r--doc/crypto/BN_num_bytes.pod37
1 files changed, 37 insertions, 0 deletions
diff --git a/doc/crypto/BN_num_bytes.pod b/doc/crypto/BN_num_bytes.pod
new file mode 100644
index 0000000000..ab12ffc657
--- /dev/null
+++ b/doc/crypto/BN_num_bytes.pod
@@ -0,0 +1,37 @@
+=pod
+
+=head1 NAME
+
+BN_num_bits, BN_num_bytes, BN_num_bits_word - Get BIGNUM size
+
+=head1 SYNOPSIS
+
+ #include <openssl/bn.h>
+
+ int BN_num_bytes(const BIGNUM *a);
+
+ int BN_num_bits(const BIGNUM *a);
+
+ int BN_num_bits_word(BN_ULONG w);
+
+=head1 DESCRIPTION
+
+These functions return the size of a B<BIGNUM> in bytes or bits,
+and the size of an unsigned integer in bits.
+
+BN_num_bytes() is a macro.
+
+=head1 RETURN VALUES
+
+The size.
+
+=head1 SEE ALSO
+
+bn(3)
+
+=head1 HISTORY
+
+BN_num_bytes(), BN_num_bits() and BN_num_bits_word() are available in
+all versions of SSLeay and OpenSSL.
+
+=cut