path: root/man3/libsimple_strnstr.3

.TH LIBSIMPLE_STRNSTR 3 2018-10-23 libsimple
.SH NAME
libsimple_strnstr \- find a substring in a string
.SH SYNOPSIS
.nf
#include <libsimple.h>

char *libsimple_strnstr(const char *\fIhaystack\fP, const char *\fIneedle\fP, size_t \fIn\fP);

#ifndef strnstr
# define strnstr libsimple_strnstr
#endif
.fi
.PP
Link with
.IR \-lsimple .
.SH DESCRIPTION
The
.BR libsimple_strnstr ()
function scans the string
.IR haystack ,
truncated to
.I n
bytes unless it is shorter,
the first occurrence of the substring
.IR needle .
.PP
The comparison is case-sensitive.
.SH RETURN VALUE
The
.BR libsimple_strnstr ()
function returns the pointer
.I haystack
with a minimal offset such that
.I r
begins with
.IR needle ,
where
.I r
is the returned pointer.
If no such offset exists,
.B NULL
is returned.
.SH ERRORS
The
.BR libsimple_strnstr ()
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_strnstr ()
T}	Thread safety	MT-Safe
T{
.BR libsimple_strnstr ()
T}	Async-signal safety	AS-Safe
T{
.BR libsimple_strnstr ()
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_strrnstr (3),
.BR libsimple_strncasestr (3)
.BR libsimple_memmem (3),
.BR strstr (3)