aboutsummaryrefslogtreecommitdiffstats
path: root/man3/libsimple_memreplaceelem.3
blob: 39cb81c59670bfb5863d49a061b26ebbd9ee9f5d (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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
.TH LIBSIMPLE_MEMREPLACEELEM 3 libsimple
.SH NAME
libsimple_memreplaceelem \- replace elements in an array

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

void *libsimple_memreplaceelem(void *\fIs\fP, int \fIold\fP, int \fInew\fP, size_t \fIwidth\fP, size_t \fIn\fP);

#ifndef memreplaceelem
# define memreplaceelem libsimple_memreplaceelem
#endif
.fi
.PP
Link with
.IR \-lsimple .

.SH DESCRIPTION
The
.BR libsimple_memreplaceelem ()
function replaces all instances of the element
.IR old ,
with size
.IR width ,
in the array
.IR s ,
with the size of
.I n
elements of size
.IR width ,
with the element
.IR new ,
also with the size
.IR width .
The replace elements in
.I s
are aligned by
.I width
bytes in
.IR s .

.SH RETURN VALUE
The
.BR libsimple_memreplaceelem ()
function returns
.IR &s[n*width] .

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

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

.SH EXAMPLES
None.

.SH APPLICATION USAGE
None.

.SH RATIONALE
None.

.SH FUTURE DIRECTIONS
None.

.SH NOTES
None.

.SH HISTORY
libsimple 1.1

.SH BUGS
None.

.SH SEE ALSO
.BR libsimple_memreplace (3),
.BR libsimple_strreplace (3),
.BR libsimple_strnreplace (3)