aboutsummaryrefslogtreecommitdiffstats
path: root/man/libkeccak_behex_upper.3
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2017-10-14 01:01:14 +0200
committerMattias Andrée <maandree@kth.se>2017-10-14 01:01:14 +0200
commit3e1864aa14a33a3c917537a241f6a032cfcacf78 (patch)
tree25297b1363fa88c9f45b5102afa5e95d08e986c1 /man/libkeccak_behex_upper.3
parentChange style and license (diff)
downloadlibkeccak-3e1864aa14a33a3c917537a241f6a032cfcacf78.tar.gz
libkeccak-3e1864aa14a33a3c917537a241f6a032cfcacf78.tar.bz2
libkeccak-3e1864aa14a33a3c917537a241f6a032cfcacf78.tar.xz
General improvements
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'man/libkeccak_behex_upper.3')
-rw-r--r--man/libkeccak_behex_upper.350
1 files changed, 50 insertions, 0 deletions
diff --git a/man/libkeccak_behex_upper.3 b/man/libkeccak_behex_upper.3
new file mode 100644
index 0000000..7925efc
--- /dev/null
+++ b/man/libkeccak_behex_upper.3
@@ -0,0 +1,50 @@
+.TH LIBKECCAK_BEHEX_UPPER 3 LIBKECCAK
+.SH NAME
+libkeccak_behex_upper - Converts a binary hashsum to uppercase hexadecimal
+.SH SYNOPSIS
+.LP
+.nf
+#include <libkeccak.h>
+.P
+void
+libkeccak_behex_upper(char *restrict \fIoutput\fP,
+ const char *restrict \fIhashsum\fP, size_t \fIn\fP);
+.fi
+.P
+Link with
+.IR -lkeccak .
+.SH DESCRIPTION
+The
+.BR libkeccak_behex_upper ()
+function
+converts a binary hashsum, stored in
+.IR hashsum ,
+to uppercase hexadecimal, and stores the
+hexadecimal representation in
+.IR output .
+.PP
+.I output
+will be terminated by a NUL-character.
+.PP
+The
+.I n
+parameter specifies the number of bytes
+the binary hashsum is comprised.
+.I output
+needs an allocation size of (2 *
+.I n
++ 1).
+.SH RETURN VALUES
+The
+.BR libkeccak_behex_upper ()
+function does return any value.
+.SH ERRORS
+The
+.BR libkeccak_behex_upper ()
+function cannot fail.
+.SH SEE ALSO
+.BR libkeccak_behex_lower (3),
+.BR libkeccak_unhex (3)
+.SH BUGS
+Please report bugs to https://github.com/maandree/libkeccak/issues or to
+maandree@kth.se