aboutsummaryrefslogblamecommitdiffstats
path: root/man/libkeccak_state_create.3
blob: 77880a3ff43d688a6de1427524dcd1cf30b47f34 (plain) (tree)
1
2
3
4
5
6
7
8
9
10
                                      






                                                           

                                                           

   

              


                             




                                                    


                             

                                  
                                                        




                             








                                                    
                                 

                                                                        
               
.TH LIBKECCAK_STATE_CREATE 3 LIBKECCAK
.SH NAME
libkeccak_state_create - Allocate and initialise hash state
.SH SYNOPSIS
.LP
.nf
#include <libkeccak.h>
.P
libkeccak_state_t *
libkeccak_state_create(const libkeccak_spec_t *\fIspec\fP);
.fi
.P
Link with
.IR -lkeccak .
.SH DESCRIPTION
The
.BR libkeccak_state_create ()
function allocates a new
.I libkeccak_state_t*
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 libkeccak_state_t*
(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)
.SH BUGS
Please report bugs to https://github.com/maandree/libkeccak/issues or to
maandree@kth.se