aboutsummaryrefslogtreecommitdiffstats
path: root/man/libkeccak_state_unmarshal.3
diff options
context:
space:
mode:
Diffstat (limited to 'man/libkeccak_state_unmarshal.3')
-rw-r--r--man/libkeccak_state_unmarshal.339
1 files changed, 39 insertions, 0 deletions
diff --git a/man/libkeccak_state_unmarshal.3 b/man/libkeccak_state_unmarshal.3
new file mode 100644
index 0000000..5a9e59b
--- /dev/null
+++ b/man/libkeccak_state_unmarshal.3
@@ -0,0 +1,39 @@
+.TH LIBKECCAK_STATE_UNMARSHAL 3 LIBKECCAK
+.SH NAME
+libkeccak_state_unmarshal - Unharshals a hash state
+.SH SYNOPSIS
+.LP
+.nf
+#include <libkeccak.h>
+.P
+size_t
+libkeccak_state_unmarshal(libkeccak_state_t *\fIstate\fP, const char *\fIdata\fP);
+.fi
+.P
+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 .
+.SH RETURN VALUES
+The
+.BR libkeccak_state_unmarshal ()
+returns the number of bytes reads from
+.IR data .
+.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_size (3),
+.BR libkeccak_state_marshal (3),
+.BR libkeccak_state_unmarshal_skip (3)
+.SH BUGS
+Please report bugs to https://github.com/maandree/libkeccak/issues or to
+maandree@kth.se