aboutsummaryrefslogtreecommitdiffstats
path: root/man3/libsimple_memscan_inv.3
diff options
context:
space:
mode:
authorMattias Andrée <maandree@kth.se>2018-11-24 15:26:17 +0100
committerMattias Andrée <maandree@kth.se>2018-11-24 15:26:17 +0100
commitce78c6d371f688ea7d6473f744fe7d09bf12121e (patch)
tree692c842ecf97f7c081f538f2b969cc5c1a8fc380 /man3/libsimple_memscan_inv.3
parentAdd tests for memelem{move,cpy} (diff)
downloadlibsimple-ce78c6d371f688ea7d6473f744fe7d09bf12121e.tar.gz
libsimple-ce78c6d371f688ea7d6473f744fe7d09bf12121e.tar.bz2
libsimple-ce78c6d371f688ea7d6473f744fe7d09bf12121e.tar.xz
Add man pages
Signed-off-by: Mattias Andrée <maandree@kth.se>
Diffstat (limited to 'man3/libsimple_memscan_inv.3')
-rw-r--r--man3/libsimple_memscan_inv.387
1 files changed, 87 insertions, 0 deletions
diff --git a/man3/libsimple_memscan_inv.3 b/man3/libsimple_memscan_inv.3
new file mode 100644
index 0000000..39a6071
--- /dev/null
+++ b/man3/libsimple_memscan_inv.3
@@ -0,0 +1,87 @@
+.TH LIBSIMPLE_MEMSCAN_INV 3 2018-11-24 libsimple
+.SH NAME
+libsimple_memscan_inv \- skip byte in memory
+.SH SYNOPSIS
+.nf
+#include <libsimple.h>
+
+void *libsimple_memscan_inv(const void *\fIs\fP, int \fIc\fP, size_t \fIn\fP);
+
+#ifndef memscan_inv
+# define memscan_inv libsimple_memscan_inv
+#endif
+.fi
+.PP
+Link with
+.IR \-lsimple .
+.SH DESCRIPTION
+The
+.BR libsimple_memscan_inv ()
+function scans the memory segment
+.IR s ,
+with the size
+.IR n ,
+for the first occurence of any byte
+other than
+.I c
+(it is converted to a
+.BR char ).
+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_memscan_inv ()
+function returns the pointer
+.I s
+with a minimal offset such that
+.IR *r!=c ,
+where
+.I r
+is the returned pointer.
+If no such offset exists,
+.I &r[n]
+is returned.
+.SH ERRORS
+The
+.BR libsimple_memscan_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_memscan_inv ()
+T} Thread safety MT-Safe
+T{
+.BR libsimple_memscan_inv ()
+T} Async-signal safety AS-Safe
+T{
+.BR libsimple_memscan_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_memscan (3),
+.BR libsimple_memchr_inv (3),
+.BR libsimple_memcasescan_inv (3),
+.BR libsimple_memrchr_inv (3),
+.BR libsimple_rawmemchr_inv (3),
+.BR libsimple_strnchrnul_inv (3),
+.BR libsimple_strchrnul_inv (3)