diff options
Diffstat (limited to '')
| -rw-r--r-- | src/lib/libc/string/memcmp.3 | 77 |
1 files changed, 77 insertions, 0 deletions
diff --git a/src/lib/libc/string/memcmp.3 b/src/lib/libc/string/memcmp.3 new file mode 100644 index 0000000000..8c35f388f2 --- /dev/null +++ b/src/lib/libc/string/memcmp.3 | |||
| @@ -0,0 +1,77 @@ | |||
| 1 | .\" Copyright (c) 1990, 1991 The Regents of the University of California. | ||
| 2 | .\" All rights reserved. | ||
| 3 | .\" | ||
| 4 | .\" This code is derived from software contributed to Berkeley by | ||
| 5 | .\" Chris Torek and the American National Standards Committee X3, | ||
| 6 | .\" on Information Processing Systems. | ||
| 7 | .\" | ||
| 8 | .\" Redistribution and use in source and binary forms, with or without | ||
| 9 | .\" modification, are permitted provided that the following conditions | ||
| 10 | .\" are met: | ||
| 11 | .\" 1. Redistributions of source code must retain the above copyright | ||
| 12 | .\" notice, this list of conditions and the following disclaimer. | ||
| 13 | .\" 2. Redistributions in binary form must reproduce the above copyright | ||
| 14 | .\" notice, this list of conditions and the following disclaimer in the | ||
| 15 | .\" documentation and/or other materials provided with the distribution. | ||
| 16 | .\" 3. Neither the name of the University nor the names of its contributors | ||
| 17 | .\" may be used to endorse or promote products derived from this software | ||
| 18 | .\" without specific prior written permission. | ||
| 19 | .\" | ||
| 20 | .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND | ||
| 21 | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
| 22 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | ||
| 23 | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE | ||
| 24 | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | ||
| 25 | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | ||
| 26 | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||
| 27 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | ||
| 28 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | ||
| 29 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | ||
| 30 | .\" SUCH DAMAGE. | ||
| 31 | .\" | ||
| 32 | .\" $OpenBSD: memcmp.3,v 1.6 2007/05/31 19:19:32 jmc Exp $ | ||
| 33 | .\" | ||
| 34 | .Dd $Mdocdate: May 31 2007 $ | ||
| 35 | .Dt MEMCMP 3 | ||
| 36 | .Os | ||
| 37 | .Sh NAME | ||
| 38 | .Nm memcmp | ||
| 39 | .Nd compare byte string | ||
| 40 | .Sh SYNOPSIS | ||
| 41 | .Fd #include <string.h> | ||
| 42 | .Ft int | ||
| 43 | .Fn memcmp "const void *b1" "const void *b2" "size_t len" | ||
| 44 | .Sh DESCRIPTION | ||
| 45 | The | ||
| 46 | .Fn memcmp | ||
| 47 | function compares byte string | ||
| 48 | .Fa b1 | ||
| 49 | against byte string | ||
| 50 | .Fa b2 . | ||
| 51 | Both strings are assumed to be | ||
| 52 | .Fa len | ||
| 53 | bytes long. | ||
| 54 | .Sh RETURN VALUES | ||
| 55 | The | ||
| 56 | .Fn memcmp | ||
| 57 | function returns zero if the two strings are identical, | ||
| 58 | otherwise returns the difference between the first two differing bytes | ||
| 59 | (treated as | ||
| 60 | .Li unsigned char | ||
| 61 | values, so that | ||
| 62 | .Sq Li \e200 | ||
| 63 | is greater than | ||
| 64 | .Sq Li \&\e0 , | ||
| 65 | for example). | ||
| 66 | Zero-length strings are always identical. | ||
| 67 | .Sh SEE ALSO | ||
| 68 | .Xr bcmp 3 , | ||
| 69 | .Xr strcasecmp 3 , | ||
| 70 | .Xr strcmp 3 , | ||
| 71 | .Xr strcoll 3 , | ||
| 72 | .Xr strxfrm 3 | ||
| 73 | .Sh STANDARDS | ||
| 74 | The | ||
| 75 | .Fn memcmp | ||
| 76 | function conforms to | ||
| 77 | .St -ansiC . | ||
