projects / apple / libc.git / blame
| Commit | Line | Data |
|---|---|---|
| 1f2f436a A |
1 | .\" Copyright (c) 2005 Pascal Gloor <pascal.gloor@spale.com> |
| 2 | .\" | |
| 3 | .\" Redistribution and use in source and binary forms, with or without | |
| 4 | .\" modification, are permitted provided that the following conditions | |
| 5 | .\" are met: | |
| 6 | .\" 1. Redistributions of source code must retain the above copyright | |
| 7 | .\" notice, this list of conditions and the following disclaimer. | |
| 8 | .\" 2. Redistributions in binary form must reproduce the above copyright | |
| 9 | .\" notice, this list of conditions and the following disclaimer in the | |
| 10 | .\" documentation and/or other materials provided with the distribution. | |
| 11 | .\" 3. The name of the author may not be used to endorse or promote | |
| 12 | .\" products derived from this software without specific prior written | |
| 13 | .\" permission. | |
| 14 | .\" | |
| 15 | .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND | |
| 16 | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
| 17 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |
| 18 | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE | |
| 19 | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |
| 20 | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | |
| 21 | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |
| 22 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | |
| 23 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | |
| 24 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | |
| 25 | .\" SUCH DAMAGE. | |
| 26 | .\" | |
| 27 | .\" $FreeBSD: src/lib/libc/string/memmem.3,v 1.3 2005/11/24 06:56:21 ru Exp $ | |
| 28 | .\" | |
| 29 | .Dd August 24, 2005 | |
| 30 | .Dt MEMMEM 3 | |
| 31 | .Os | |
| 32 | .Sh NAME | |
| 33 | .Nm memmem | |
| 34 | .Nd "locate a byte substring in a byte string" | |
| 35 | .Sh LIBRARY | |
| 36 | .Lb libc | |
| 37 | .Sh SYNOPSIS | |
| 38 | .In string.h | |
| 39 | .Ft "void *" | |
| 40 | .Fo memmem | |
| 41 | .Fa "const void *big" "size_t big_len" | |
| 42 | .Fa "const void *little" "size_t little_len" | |
| 43 | .Fc | |
| 44 | .Sh DESCRIPTION | |
| 45 | The | |
| 46 | .Fn memmem | |
| 47 | function | |
| 48 | locates the first occurrence of the byte string | |
| 49 | .Fa little | |
| 50 | in the byte string | |
| 51 | .Fa big . | |
| 52 | .Sh RETURN VALUES | |
| 53 | If | |
| 54 | .Fa big_len | |
| 55 | is smaller than | |
| 56 | .Fa little_len , | |
| 57 | if | |
| 58 | .Fa little_len | |
| 59 | is 0, if | |
| 60 | .Fa big_len | |
| 61 | is 0 or if | |
| 62 | .Fa little | |
| 63 | occurs nowhere in | |
| 64 | .Fa big , | |
| 65 | .Dv NULL | |
| 66 | is returned; | |
| 67 | otherwise a pointer to the first character of the first occurrence of | |
| 68 | .Fa little | |
| 69 | is returned. | |
| 70 | .Sh SEE ALSO | |
| 71 | .Xr memchr 3 , | |
| 72 | .Xr strchr 3 , | |
| 73 | .Xr strstr 3 | |
| 74 | .Sh CONFORMING TO | |
| 75 | .Fn memmem | |
| 76 | is a GNU extension. | |
| 77 | .Sh HISTORY | |
| 78 | The | |
| 79 | .Fn memmem | |
| 80 | function first appeared in | |
| 81 | .Fx 6.0 . | |
| 82 | .Sh AUTHORS | |
| 83 | .An Pascal Gloor Aq pascal.gloor@spale.com | |
| 84 | .Sh BUGS | |
| 85 | This function was broken in Linux libc up to and including version 5.0.9 | |
| 86 | and in GNU libc prior to version 2.1. |