diff options
author | Mattias Andrée <maandree@kth.se> | 2024-09-15 00:47:51 +0200 |
---|---|---|
committer | Mattias Andrée <maandree@kth.se> | 2024-09-15 00:47:51 +0200 |
commit | f14ba70de62cbd47e074756b1f1aec1f3b77a02d (patch) | |
tree | 4b4c27260816f553b7a1fe54153c06b122160ffc /man3/libkeccak_state_duplicate.3 | |
parent | Split libkeccak.h and fix support for architectures that do not allow misaligned memory (diff) | |
download | libkeccak-f14ba70de62cbd47e074756b1f1aec1f3b77a02d.tar.gz libkeccak-f14ba70de62cbd47e074756b1f1aec1f3b77a02d.tar.bz2 libkeccak-f14ba70de62cbd47e074756b1f1aec1f3b77a02d.tar.xz |
Move man pages into man3/ and man7/
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'man3/libkeccak_state_duplicate.3')
-rw-r--r-- | man3/libkeccak_state_duplicate.3 | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/man3/libkeccak_state_duplicate.3 b/man3/libkeccak_state_duplicate.3 new file mode 100644 index 0000000..ef0bcba --- /dev/null +++ b/man3/libkeccak_state_duplicate.3 @@ -0,0 +1,41 @@ +.TH LIBKECCAK_STATE_DUPLICATE 3 LIBKECCAK +.SH NAME +libkeccak_state_duplicate - Allocate a duplicate hash state +.SH SYNOPSIS +.nf +#include <libkeccak.h> + +struct libkeccak_state *libkeccak_state_duplicate(const struct libkeccak_state *\fIsrc\fP); +.fi +.PP +Link with +.IR -lkeccak P. +.SH DESCRIPTION +The +.BR libkeccak_state_duplicate () +function allocates a new hash state and initialises it +to be identical to +.IR *src . +This includes all members of the +.B struct libkeccak_state +structure, including the state of the sponge and the +message chunk buffer. +.SH RETURN VALUES +The +.BR libkeccak_state_duplicate () +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_duplicate () +function may fail for any specified for the function +.BR malloc (3). +.SH SEE ALSO +.BR libkeccak_state_copy (3), +.BR libkeccak_state_create (3) |