aboutsummaryrefslogtreecommitdiffstats
path: root/man3/libkeccak_state_marshal.3
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2019-02-09 21:56:53 +0100
committerMattias Andrée <maandree@kth.se>2019-02-09 21:56:53 +0100
commit7085817a3d356f7c3240fe1d616a5b1f1b56e38a (patch)
tree9bfebc7c3330d99410cc8a73af3ee2f21e386be0 /man3/libkeccak_state_marshal.3
parentRemove texinfo file (it was truncated anyhow for some reason) (diff)
downloadlibkeccak-7085817a3d356f7c3240fe1d616a5b1f1b56e38a.tar.gz
libkeccak-7085817a3d356f7c3240fe1d616a5b1f1b56e38a.tar.bz2
libkeccak-7085817a3d356f7c3240fe1d616a5b1f1b56e38a.tar.xz
Fix makefile add add OSCONFIGFILE
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'man3/libkeccak_state_marshal.3')
-rw-r--r--man3/libkeccak_state_marshal.341
1 files changed, 41 insertions, 0 deletions
diff --git a/man3/libkeccak_state_marshal.3 b/man3/libkeccak_state_marshal.3
new file mode 100644
index 0000000..f5d5e05
--- /dev/null
+++ b/man3/libkeccak_state_marshal.3
@@ -0,0 +1,41 @@
+.TH LIBKECCAK_STATE_MARSHAL 3 LIBKECCAK
+.SH NAME
+libkeccak_state_marshal - Marshals a hash state
+.SH SYNOPSIS
+.LP
+.nf
+#include <libkeccak.h>
+.P
+size_t
+libkeccak_state_marshal(const libkeccak_state_t *\fIstate\fP, char *\fIdata\fP);
+.fi
+.P
+Link with
+.IR -lkeccak .
+.SH DESCRIPTION
+The
+.BR libkeccak_state_marshal ()
+function marshals \fI*state\fP into the beginning of
+.IR data .
+.PP
+Use the
+.BR libkeccak_state_marshal_size (3)
+function to get minimum usable allocation size
+for
+.IR data .
+.SH RETURN VALUES
+The
+.BR libkeccak_state_marshal ()
+returns the number of bytes written to
+.IR data .
+.SH ERRORS
+The
+.BR libkeccak_state_marshal ()
+function cannot fail.
+.SH SEE ALSO
+.BR libkeccak_state_marshal_size (3),
+.BR libkeccak_state_unmarshal (3),
+.BR libkeccak_state_unmarshal_skip (3)
+.SH BUGS
+Please report bugs to https://github.com/maandree/libkeccak/issues or to
+maandree@kth.se