diff options
author | Mattias Andrée <maandree@kth.se> | 2017-10-14 01:01:14 +0200 |
---|---|---|
committer | Mattias Andrée <maandree@kth.se> | 2017-10-14 01:01:14 +0200 |
commit | 3e1864aa14a33a3c917537a241f6a032cfcacf78 (patch) | |
tree | 25297b1363fa88c9f45b5102afa5e95d08e986c1 /man/libkeccak_state_copy.3 | |
parent | Change style and license (diff) | |
download | libkeccak-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_state_copy.3')
-rw-r--r-- | man/libkeccak_state_copy.3 | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/man/libkeccak_state_copy.3 b/man/libkeccak_state_copy.3 new file mode 100644 index 0000000..c9283ca --- /dev/null +++ b/man/libkeccak_state_copy.3 @@ -0,0 +1,44 @@ +.TH LIBKECCAK_STATE_COPY 3 LIBKECCAK +.SH NAME +libkeccak_state_copy - Copies hash state +.SH SYNOPSIS +.LP +.nf +#include <libkeccak.h> +.P +int +libkeccak_state_copy(libkeccak_state_t *\fIdest\fP, + const libkeccak_state_t *\fIsrc\fP); +.fi +.P +Link with +.IR -lkeccak . +.SH DESCRIPTION +The +.BR libkeccak_state_copy () +function initialises +.I *dest +to be identical to +.IR *src . +This includes all members of the +.B libkeccak_state_t +structure, including the state of the sponge and the +message chunk buffer. +.SH RETURN VALUES +The +.BR libkeccak_state_copy () +function returns 0 upon successful completion. +On error, -1 is returned and +.I errno +is set to describe the error. +.SH ERRORS +The +.BR libkeccak_state_copy () +function may fail for any specified for the function +.BR malloc (3). +.SH SEE ALSO +.BR libkeccak_state_duplicate (3), +.BR libkeccak_state_initialise (3) +.SH BUGS +Please report bugs to https://github.com/maandree/libkeccak/issues or to +maandree@kth.se |