diff options
Diffstat (limited to '')
-rw-r--r-- | man/libsimple_memmem.3 | 77 |
1 files changed, 77 insertions, 0 deletions
diff --git a/man/libsimple_memmem.3 b/man/libsimple_memmem.3 new file mode 100644 index 0000000..f084de9 --- /dev/null +++ b/man/libsimple_memmem.3 @@ -0,0 +1,77 @@ +.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 *haystack, size_t nhaystack, const void *needle, size_t nneedle); + +#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 memchr (3) |