aboutsummaryrefslogtreecommitdiffstats
path: root/libkeccak_state_unmarshal.3
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2019-02-12 18:46:12 +0100
committerMattias Andrée <maandree@kth.se>2019-02-12 18:46:12 +0100
commit47139985115e175ed9c3f7d648d6d9ec7c48b89b (patch)
tree846111020e7a2bb3bcd85cf00ceb158d07dc0c28 /libkeccak_state_unmarshal.3
parentUpdate makefile (diff)
downloadlibkeccak-47139985115e175ed9c3f7d648d6d9ec7c48b89b.tar.gz
libkeccak-47139985115e175ed9c3f7d648d6d9ec7c48b89b.tar.bz2
libkeccak-47139985115e175ed9c3f7d648d6d9ec7c48b89b.tar.xz
Deprecate libkeccak_{state,hmac}_{unmarshal_skip,marshal_size} and replace with the functions without the _skip or _size suffix
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to '')
-rw-r--r--libkeccak_state_unmarshal.321
1 files changed, 17 insertions, 4 deletions
diff --git a/libkeccak_state_unmarshal.3 b/libkeccak_state_unmarshal.3
index 3881550..6198e3a 100644
--- a/libkeccak_state_unmarshal.3
+++ b/libkeccak_state_unmarshal.3
@@ -18,17 +18,30 @@ 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
-.IR data .
+.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_size (3),
-.BR libkeccak_state_marshal (3),
-.BR libkeccak_state_unmarshal_skip (3)
+.BR libkeccak_state_marshal (3)