diff options
author | Mattias Andrée <maandree@kth.se> | 2018-11-07 22:18:04 +0100 |
---|---|---|
committer | Mattias Andrée <maandree@kth.se> | 2018-11-07 22:18:04 +0100 |
commit | 9fc2b129167e1f2a16d942369f057f618a00d81c (patch) | |
tree | c15d15d8afc525a423ce0d43d95f676e6e5a2541 /man3/libsimple_memrelem.3 | |
parent | Add arrayalloc man page (diff) | |
download | libsimple-9fc2b129167e1f2a16d942369f057f618a00d81c.tar.gz libsimple-9fc2b129167e1f2a16d942369f057f618a00d81c.tar.bz2 libsimple-9fc2b129167e1f2a16d942369f057f618a00d81c.tar.xz |
Move section 3 man pages to man3/ and add libsimple.h.0
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'man3/libsimple_memrelem.3')
-rw-r--r-- | man3/libsimple_memrelem.3 | 84 |
1 files changed, 84 insertions, 0 deletions
diff --git a/man3/libsimple_memrelem.3 b/man3/libsimple_memrelem.3 new file mode 100644 index 0000000..203ffee --- /dev/null +++ b/man3/libsimple_memrelem.3 @@ -0,0 +1,84 @@ +.TH LIBSIMPLE_MEMRELEM 3 2018-10-20 libsimple +.SH NAME +libsimple_memrelem \- find aligned byte string in memory +.SH SYNOPSIS +.nf +#include <libsimple.h> + +void *libsimple_memrelem(const void *\fIhaystack\fP, size_t \fInhaystack\fP, const void *\fIneedle\fP, size_t \fInneedle\fP); + +#ifndef memrelem +# define memrelem libsimple_memrelem +#endif +.fi +.PP +Link with +.IR \-lsimple . +.SH DESCRIPTION +The +.BR libsimple_memrelem () +function scans the memory segment +.IR haystack , +with the size +.IR nhaystack*nneedle , +for the last occurence of the byte string +.I needle +with the size +.IR nneedle , +and with an offset equivalent to zero modulo +.IR nneedle . +.PP +The comparison is case-sensitive. +.SH RETURN VALUE +The +.BR libsimple_memrelem () +function returns the pointer +.I s +with a maximal offset such that +.IR !memcmp(r,needle,nneedle) , +where +.I r +is the returned pointer, and such that +the offset is equivalent to zero modulo +.IR nneedle . +If no such offset exists, +.B NULL +is returned. +.SH ERRORS +The +.BR libsimple_memrelem () +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_memrelem () +T} Thread safety MT-Safe +T{ +.BR libsimple_memrelem () +T} Async-signal safety AS-Safe +T{ +.BR libsimple_memrelem () +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_memelem (3), +.BR libsimple_memrmem (3), +.BR libsimple_memrchr (3) |