git.saurik.com Git - apple/libc.git/blame_incremental

... / ...

Commit	Line	Data
	1	.\" Copyright (c) 1990, 1991, 1993
	2	.\" The Regents of the University of California. 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	.\" 4. 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	.\" @(#)strcmp.3 8.1 (Berkeley) 6/4/93
	33	.\" $FreeBSD: src/lib/libc/string/strcmp.3,v 1.13 2009/12/04 09:20:20 trhodes Exp $
	34	.\"
	35	.Dd October 11, 2001
	36	.Dt STRCMP 3
	37	.Os
	38	.Sh NAME
	39	.Nm strcmp ,
	40	.Nm strncmp
	41	.Nd compare strings
	42	.Sh LIBRARY
	43	.Lb libc
	44	.Sh SYNOPSIS
	45	.In string.h
	46	.Ft int
	47	.Fo strcmp
	48	.Fa "const char *s1"
	49	.Fa "const char *s2"
	50	.Fc
	51	.Ft int
	52	.Fo strncmp
	53	.Fa "const char *s1"
	54	.Fa "const char *s2"
	55	.Fa "size_t n"
	56	.Fc
	57	.Sh DESCRIPTION
	58	The
	59	.Fn strcmp
	60	and
	61	.Fn strncmp
	62	functions
	63	lexicographically compare the null-terminated strings
	64	.Fa s1
	65	and
	66	.Fa s2 .
	67	.Pp
	68	The
	69	.Fn strncmp
	70	function
	71	compares not more than
	72	.Fa n
	73	characters.
	74	Because
	75	.Fn strncmp
	76	is designed for comparing strings rather than binary data,
	77	characters that appear after a
	78	.Ql \e0
	79	character are not compared.
	80	.Sh RETURN VALUES
	81	The
	82	.Fn strcmp
	83	and
	84	.Fn strncmp
	85	functions return an integer greater than, equal to, or less than 0, according
	86	as the string
	87	.Fa s1
	88	is greater than, equal to, or less than the string
	89	.Fa s2 .
	90	The comparison is done using unsigned characters, so that
	91	.Ql \e200
	92	is greater than
	93	.Ql \e0 .
	94	.Sh SEE ALSO
	95	.Xr bcmp 3 ,
	96	.Xr memcmp 3 ,
	97	.Xr strcasecmp 3 ,
	98	.Xr strcoll 3 ,
	99	.Xr strxfrm 3 ,
	100	.Xr wcscmp 3
	101	.Sh STANDARDS
	102	The
	103	.Fn strcmp
	104	and
	105	.Fn strncmp
	106	functions
	107	conform to
	108	.St -isoC .