librecrypt/librecrypt_set_user_data.3 at master · maandree/librecrypt · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
.TH LIBRECRYPT_SET_USER_DATA 3 LIBRECRYPT
.SH NAME
librecrypt_set_user_data - Set application-defined data

.SH SYNOPSIS
.nf
#include <librecrypt.h>

void \fBlibrecrypt_set_user_data\fP(LIBRECRYPT_CONTEXT *\fIctx\fP, void *\fIuser\fP);
.fi
.PP
Link with
.IR -lrecrypt .

.SH DESCRIPTION
The
.BR librecrypt_set_user_data ()
function stores a pointer to application-defined
data, provided via the
.I user
parameter, inside the
.IR ctx .
.PP
The caller is responsible for the lifetime of
.IR user :
deallocating it will deallocate it for
.I *ctx
as it only holds a reference to
.IR user ,
not a copy of it.

.SH RETURN VALUES
None.

.SH ERRORS
The
.BR librecrypt_set_user_data ()
function cannot fail.

.SH HISTORY
The
.BR librecrypt_set_user_data ()
function was introduced in version 1.1 of
.BR librecrypt .

.SH SEE ALSO
.BR librecrypt (7),
.BR librecrypt_get_user_data (3),
.BR librecrypt_set_custom_algorithms (3)