$OpenBSD: strnstr.9,v 1.1 2023/12/21 02:57:14 jsg Exp $

Copyright (c) 2001 Mike Barcroft <mike@FreeBSD.org>
Copyright (c) 1990, 1991, 1993
The Regents of the University of California. All rights reserved.

This code is derived from software contributed to Berkeley by
Chris Torek and the American National Standards Committee X3,
on Information Processing Systems.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. Neither the name of the University nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.

.Dd $Mdocdate$ .Dt STRNSTR 9 .Os .Sh NAME .Nm strnstr .Nd locate a substring in a string .Sh SYNOPSIS n lib/libkern/libkern.h .Ft char * .Fn strnstr "const char *big" "const char *little" "size_t len" .Sh DESCRIPTION The .Fn strnstr function locates the first occurrence of the null-terminated string .Fa little in the string .Fa big , where not more than .Fa len characters are searched. Characters that appear after a .Ql \e0 character are not searched. .Sh RETURN VALUES If .Fa little is an empty string, .Fa big is returned; if .Fa little occurs nowhere in .Fa big , .Dv NULL is returned; otherwise a pointer to the first character of the first occurrence of .Fa little is returned. .Sh EXAMPLES The following sets the pointer .Va ptr to .Dv NULL , because only the first 4 characters of .Va largestring are searched: d -literal -offset indent const char *largestring = "Foo Bar Baz"; const char *smallstring = "Bar"; char *ptr; ptr = strnstr(largestring, smallstring, 4); .Ed .Sh SEE ALSO .Xr memchr 9