path: root/doc/man/libkeccak_behex_upper.3

.TH LIBKECCAK_BEHEX_UPPER 3 LIBKECCAK-%VERSION%
.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 \fI-lkeccak\fP.
.SH DESCRIPTION
The
.BR libkeccak_behex_upper ()
function
converts a binary hashsum, stored in \fIhashsum\fP,
to uppercase hexadecimal, and stores the
hexadecimal representation in \fIoutput\fP.
.PP
\fIoutput\fP will be terminated by a NUL-character.
.PP
The \fIn\fP parameter specifies the number of bytes
the binary hashsum is comprised. \fIoutput\fP needs
an allocation size of (2 * \fIn\fP + 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 AUTHORS
Principal author, Mattias Andrée.  See the LICENSE file for the full
list of authors.
.SH BUGS
Please report bugs to https://github.com/maandree/libkeccak/issues or to
maandree@kth.se