diff options
Diffstat (limited to '')
-rw-r--r-- | man3/libsimple_memelemscan_inv.3 | 88 |
1 files changed, 88 insertions, 0 deletions
diff --git a/man3/libsimple_memelemscan_inv.3 b/man3/libsimple_memelemscan_inv.3 new file mode 100644 index 0000000..77f7119 --- /dev/null +++ b/man3/libsimple_memelemscan_inv.3 @@ -0,0 +1,88 @@ +.TH LIBSIMPLE_MEMELEMSCAN_INV 3 2018-11-24 libsimple +.SH NAME +libsimple_memelemscan_inv \- skip aligned byte string in memory +.SH SYNOPSIS +.nf +#include <libsimple.h> + +void *libsimple_memelemscan_inv(const void *\fIhaystack\fP, size_t \fInhaystack\fP, const void *\fIneedle\fP, size_t \fInneedle\fP); + +#ifndef memelemscan_inv +# define memelemscan_inv libsimple_memelemscan_inv +#endif +.fi +.PP +Link with +.IR \-lsimple . +.SH DESCRIPTION +The +.BR libsimple_memelemscan_inv () +function scans the memory segment +.IR haystack , +with the size +.IR nhaystack*nneedle , +for the first occurence of a byte string +different from +.I needle +with the size +.IR nneedle , +and with an offset equivalent to zero modulo +.IR nneedle . +If no such character exist in the memory +segment, the memory segment's end is returned. +.PP +The comparison is case-sensitive. +.SH RETURN VALUE +The +.BR libsimple_memelemscan_inv () +function returns the pointer +.I s +with a minimal 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, +.I (void *)&((char *)haystack)[nhaystack*nneedle] +is returned. +.SH ERRORS +The +.BR libsimple_memelemscan_inv () +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_memelemscan_inv () +T} Thread safety MT-Safe +T{ +.BR libsimple_memelemscan_inv () +T} Async-signal safety AS-Safe +T{ +.BR libsimple_memelemscan_inv () +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_memelemscan (3), +.BR libsimple_memelem_inv (3), +.BR libsimple_memrelem_inv (3), +.BR libsimple_memchrscan_inv (3) |