path: root/doc/man/libkeccak_hmac_copy.3

.TH LIBKECCAK_HMAC_COPY 3 LIBKECCAK-%VERSION%
.SH NAME
libkeccak_hmac_copy - Copies an HMAC-hashing state
.SH SYNOPSIS
.LP
.nf
#include <libkeccak.h>
.P
int libkeccak_hmac_copy(libkeccak_hmac_state_t *\fIdest\fP,
                        const libkeccak_hmac_state_t *\fIsrc\fP);
.fi
.P
Link with \fI-lkeccak\fP.
.SH DESCRIPTION
The
.BR libkeccak_hmac_copy ()
function initialises \fI*dest\fP to be identical to \fI*src\fP.
This includes all members of the \fBlibkeccak_hmac_state_t\fP
structure, including the state of the sponge and the
message chunk buffer.
.SH RETURN VALUES
The
.BR libkeccak_hmac_copy ()
function returns 0 upon successful completion.
On error, -1 is returned and \fIerrno\fP is set to describe
the error.
.SH ERRORS
The
.BR libkeccak_hmac_copy ()
function may fail for any specified for the function
.BR malloc (3).
.SH SEE ALSO
.BR libkeccak_hmac_duplicate (3),
.BR libkeccak_hmac_initialise (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