aboutsummaryrefslogtreecommitdiffstats
path: root/libkeccak_state_create.3
blob: d0374356645f1a8afbd63175306ee7469a57e58c (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
.TH LIBKECCAK_STATE_CREATE 3 LIBKECCAK
.SH NAME
libkeccak_state_create - Allocate and initialise hash state
.SH SYNOPSIS
.nf
#include <libkeccak.h>

struct libkeccak_state *libkeccak_state_create(const struct libkeccak_spec *\fIspec\fP);
.fi
.PP
Link with
.IR -lkeccak .
.SH DESCRIPTION
The
.BR libkeccak_state_create ()
function allocates a new
.I struct libkeccak_state *
with one initialised element, and sets the algorithm
tuning parameters to those specified by
.IR *spec .
.SH RETURN VALUES
The
.BR libkeccak_state_create ()
function returns a newly allocated
.I struct libkeccak_state *
(of one initialised element) upon successful completion.
On error,
.I NULL
is returned and
.I errno
is set to describe the error.
.SH ERRORS
The
.BR libkeccak_state_create ()
function may fail for any specified for the function
.BR malloc (3).
.SH SEE ALSO
.BR libkeccak_state_initialise (3),
.BR libkeccak_state_free (3),
.BR libkeccak_state_fast_free (3)
.BR libkeccak_state_duplicate (3)