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_unmarshal.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_unmarshal.3')
-rw-r--r-- | man3/libkeccak_state_unmarshal.3 | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/man3/libkeccak_state_unmarshal.3 b/man3/libkeccak_state_unmarshal.3 new file mode 100644 index 0000000..6198e3a --- /dev/null +++ b/man3/libkeccak_state_unmarshal.3 @@ -0,0 +1,47 @@ +.TH LIBKECCAK_STATE_UNMARSHAL 3 LIBKECCAK +.SH NAME +libkeccak_state_unmarshal - Unharshals a hash state +.SH SYNOPSIS +.nf +#include <libkeccak.h> + +size_t libkeccak_state_unmarshal(struct libkeccak_state *\fIstate\fP, const void *\fIdata\fP); +.fi +.PP +Link with +.IR -lkeccak . +.SH DESCRIPTION +The +.BR libkeccak_state_unmarshal () +function unmarshals a hash state from the beginning +of +.IR data . +and stores it in +.IR *state . +.I state +may be +.IR NULL . +.SH RETURN VALUES +The +.BR libkeccak_state_unmarshal () +returns the number of bytes reads from +.I data +upon successful completion. +On error, -1 is returned and +.I errno +is set to describe the error. +If +.I state +is +.IR NULL , +the number the function will always be +successful and return a positive value, +this value is the number of bytes that +make un the marshalled state. +.SH ERRORS +The +.BR libkeccak_state_unmarshal () +function may fail for any specified for the function +.BR malloc (3). +.SH SEE ALSO +.BR libkeccak_state_marshal (3) |