aboutsummaryrefslogtreecommitdiffstats
path: root/doc/man/libkeccak_hmac_unmarshal.3
diff options
context:
space:
mode:
authorMattias Andrée <maandree@operamail.com>2015-10-11 13:39:39 +0200
committerMattias Andrée <maandree@operamail.com>2015-10-11 13:39:39 +0200
commit46ccd59e30629517562b3a4cdc546be148769154 (patch)
treec5747220bbc1bccc7ce7107a43836bc53ad60e18 /doc/man/libkeccak_hmac_unmarshal.3
parentadd libkeccak_hmac_copy.3 and libkeccak_hmac_duplicate.3 (diff)
downloadlibkeccak-46ccd59e30629517562b3a4cdc546be148769154.tar.gz
libkeccak-46ccd59e30629517562b3a4cdc546be148769154.tar.bz2
libkeccak-46ccd59e30629517562b3a4cdc546be148769154.tar.xz
add libkeccak_hmac_marshal_size.3, libkeccak_hmac_marshal.3, libkeccak_hmac_unmarshal.3, and libkeccak_hmac_unmarshal_skip.3
Signed-off-by: Mattias Andrée <maandree@operamail.com>
Diffstat (limited to '')
-rw-r--r--doc/man/libkeccak_hmac_unmarshal.336
1 files changed, 36 insertions, 0 deletions
diff --git a/doc/man/libkeccak_hmac_unmarshal.3 b/doc/man/libkeccak_hmac_unmarshal.3
new file mode 100644
index 0000000..816f9dc
--- /dev/null
+++ b/doc/man/libkeccak_hmac_unmarshal.3
@@ -0,0 +1,36 @@
+.TH LIBKECCAK_HMAC_UNMARSHAL 3 LIBKECCAK-%VERSION%
+.SH NAME
+libkeccak_hmac_unmarshal - Unharshals an HMAC-hashing state
+.SH SYNOPSIS
+.LP
+.nf
+#include <libkeccak.h>
+.P
+size_t libkeccak_hmac_unmarshal(libkeccak_hmac_state_t *\fIstate\fP, const char *\fIdata\fP);
+.fi
+.P
+Link with \fI-lkeccak\fP.
+.SH DESCRIPTION
+The
+.BR libkeccak_hmac_unmarshal ()
+function unmarshals an HMAC-hashing state from the beginning
+of \fIdata\fP. and stores it in \fI*state\fP.
+.SH RETURN VALUES
+The
+.BR libkeccak_hmac_unmarshal ()
+returns the number of bytes reads from \fIdata\fP.
+.SH ERRORS
+The
+.BR libkeccak_hmac_unmarshal ()
+function may fail for any specified for the function
+.BR malloc (3).
+.SH SEE ALSO
+.BR libkeccak_hmac_marshal_size (3),
+.BR libkeccak_hmac_marshal (3),
+.BR libkeccak_hmac_unmarshal_skip (3)
+.SH AUTHORS
+Principal author, Mattias Andrée. See the LICENSE file for the full
+list of authors.
+.SH BUGS
+Please report bugs to https://github.com/maandree/libkeccak/issues or to
+maandree@member.fsf.org