aboutsummaryrefslogtreecommitdiffstats
path: root/man/libsimple_memmem.3
blob: 18dec5de1d250d57310b10cf66a73152b824f6bd (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
.TH LIBSIMPLE_MEMMEM 3 2018-10-20 libsimple
.SH NAME
libsimple_memmem \- find byte string in memory
.SH SYNOPSIS
.nf
#include <libsimple.h>

void *libsimple_memmem(const void *\fIhaystack\fP, size_t \fInhaystack\fP, const void *\fIneedle\fP, size_t \fInneedle\fP);

#ifndef memmem
# define memmem libsimple_memmem
#endif
.fi

Link with
.IR \-lsimple .
.SH DESCRIPTION
The
.BR libsimple_memmem ()
function scans the memory segment
.IR haystack ,
with the size
.IR nhaystack ,
for the first occurence of the byte string
.I needle
with the size
.IR nneedle .
.SH RETURN VALUE
The
.BR libsimple_memmem ()
function returns the pointer
.I s
with a minimal offset such that
.IR !memcmp(r,needle,nneedle) ,
where
.I r
is the returned pointer.
If no such offset exists,
.B NULL
is returned.
.SH ERRORS
The
.BR libsimple_memmem ()
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_memmem ()
T}	Thread safety	MT-Safe
T{
.BR libsimple_memmem ()
T}	Async-signal safety	AS-Safe
T{
.BR libsimple_memmem ()
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 BUGS
None.
.SH SEE ALSO
.BR libsimple_memrmem (3),
.BR libsimple_memelem (3),
.BR memchr (3)