aboutsummaryrefslogtreecommitdiffstats
path: root/librecrypt_wipe_str.3
blob: 80aa301e47b08f3dd757d35b12761a75b7466626 (plain) (blame)
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
50
51
52
53
54
55
56
57
58
59
60
61
.TH LIBRECRYPT_WIPE_STR 3 LIBRECRYPT
.SH NAME
librecrypt_wipe_str - Securely erase a string

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

void \fBlibrecrypt_wipe_str\fP(char *\fIstring\fP);
.fi
.PP
Link with
.IR -lrecrypt .

.SH DESCRIPTION
The
.BR librecrypt_wipe_str ()
function securely erases the string referenced by
.IR string .
.PP
If
.I string
is
.IR NULL ,
no action is taken.

.SH RETURN VALUES
None.

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

.SH ATTRIBUTES
For an explanation of the terms used in this section, see
.BR attributes (7).
.PP
.TS
allbox;
lb lb lb
l l l.
Interface	Attribute	Value
T{
.BR librecrypt_wipe_str ()
T}	Thread safety	MT-Safe
T{
.BR librecrypt_wipe_str ()
T}	Async-signal safety	AS-Safe
.TE
.sp

.SH HISTORY
The
.BR librecrypt_wipe_str ()
function was introduced in version 1.0 of
.BR librecrypt .

.SH SEE ALSO
.BR librecrypt (7),
.BR librecrypt_wipe (3)