aboutsummaryrefslogtreecommitdiffstats
path: root/doc/man/libkeccak_behex_upper.3
blob: 7925efc2d8c7b72e937eda02f7ac789a94ee32f0 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
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