[apple/libc.git] / string / strcasecmp.3

.\" 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.
.\" 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. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 4. 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.
.\"
.\"     @(#)strcasecmp.3	8.1 (Berkeley) 6/9/93
.\" $FreeBSD: src/lib/libc/string/strcasecmp.3,v 1.9 2001/10/01 16:09:00 ru Exp $
.\"
.Dd June 9, 1993
.Dt STRCASECMP 3
.Os
.Sh NAME
.Nm strcasecmp ,
.Nm strncasecmp
.Nd compare strings, ignoring case
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In string.h
.Ft int
.Fn strcasecmp "const char *s1" "const char *s2"
.Ft int
.Fn strncasecmp "const char *s1" "const char *s2" "size_t len"
.Sh DESCRIPTION
The
.Fn strcasecmp
and
.Fn strncasecmp
functions
compare the null-terminated strings
.Fa s1
and
.Fa s2 .
.Pp
The
.Fn strncasecmp
compares at most
.Fa len
characters.
.Sh RETURN VALUES
The
.Fn strcasecmp
and
.Fn strncasecmp
return an integer greater than, equal to, or less than 0,
according as
.Fa s1
is lexicographically greater than, equal to, or less than
.Fa s2
after translation of each corresponding character to lower-case.
The strings themselves are not modified.
The comparison is done using unsigned characters, so that
.Sq Li \e200
is greater than
.Ql \e0 .
.Sh SEE ALSO
.Xr bcmp 3 ,
.Xr memcmp 3 ,
.Xr strcmp 3 ,
.Xr strcoll 3 ,
.Xr strxfrm 3 ,
.Xr tolower 3
.Sh HISTORY
The
.Fn strcasecmp
and
.Fn strncasecmp
functions first appeared in
.Bx 4.4 .
Commit	Line	Data
5b2abdfb	1	.\" Copyright (c) 1990, 1991, 1993
e9ce8d39 A	2	.\" The Regents of the University of California. All rights reserved.
e9ce8d39 A	3	.\"
5b2abdfb A	4	.\" This code is derived from software contributed to Berkeley by
5b2abdfb A	5	.\" Chris Torek.
e9ce8d39 A	6	.\" Redistribution and use in source and binary forms, with or without
	7	.\" modification, are permitted provided that the following conditions
	8	.\" are met:
	9	.\" 1. Redistributions of source code must retain the above copyright
	10	.\" notice, this list of conditions and the following disclaimer.
	11	.\" 2. Redistributions in binary form must reproduce the above copyright
	12	.\" notice, this list of conditions and the following disclaimer in the
	13	.\" documentation and/or other materials provided with the distribution.
	14	.\" 3. All advertising materials mentioning features or use of this software
	15	.\" must display the following acknowledgement:
	16	.\" This product includes software developed by the University of
	17	.\" California, Berkeley and its contributors.
	18	.\" 4. Neither the name of the University nor the names of its contributors
	19	.\" may be used to endorse or promote products derived from this software
	20	.\" without specific prior written permission.
	21	.\"
	22	.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	23	.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	24	.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	25	.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	26	.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	27	.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	28	.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	29	.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	30	.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	31	.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	32	.\" SUCH DAMAGE.
	33	.\"
5b2abdfb A	34	.\" @(#)strcasecmp.3 8.1 (Berkeley) 6/9/93
5b2abdfb A	35	.\" $FreeBSD: src/lib/libc/string/strcasecmp.3,v 1.9 2001/10/01 16:09:00 ru Exp $
e9ce8d39	36	.\"
5b2abdfb A	37	.Dd June 9, 1993
5b2abdfb A	38	.Dt STRCASECMP 3
e9ce8d39 A	39	.Os
e9ce8d39 A	40	.Sh NAME
5b2abdfb A	41	.Nm strcasecmp ,
	42	.Nm strncasecmp
	43	.Nd compare strings, ignoring case
e9ce8d39 A	44	.Sh LIBRARY
	45	.Lb libc
	46	.Sh SYNOPSIS
5b2abdfb	47	.In string.h
e9ce8d39	48	.Ft int
5b2abdfb A	49	.Fn strcasecmp "const char s1" "const char s2"
	50	.Ft int
	51	.Fn strncasecmp "const char s1" "const char s2" "size_t len"
e9ce8d39 A	52	.Sh DESCRIPTION
e9ce8d39 A	53	The
5b2abdfb	54	.Fn strcasecmp
e9ce8d39	55	and
5b2abdfb A	56	.Fn strncasecmp
	57	functions
	58	compare the null-terminated strings
	59	.Fa s1
	60	and
	61	.Fa s2 .
	62	.Pp
e9ce8d39	63	The
5b2abdfb A	64	.Fn strncasecmp
5b2abdfb A	65	compares at most
e9ce8d39	66	.Fa len
5b2abdfb A	67	characters.
	68	.Sh RETURN VALUES
	69	The
	70	.Fn strcasecmp
	71	and
	72	.Fn strncasecmp
	73	return an integer greater than, equal to, or less than 0,
	74	according as
	75	.Fa s1
	76	is lexicographically greater than, equal to, or less than
	77	.Fa s2
	78	after translation of each corresponding character to lower-case.
	79	The strings themselves are not modified.
	80	The comparison is done using unsigned characters, so that
	81	.Sq Li \e200
	82	is greater than
	83	.Ql \e0 .
e9ce8d39	84	.Sh SEE ALSO
5b2abdfb A	85	.Xr bcmp 3 ,
	86	.Xr memcmp 3 ,
	87	.Xr strcmp 3 ,
	88	.Xr strcoll 3 ,
	89	.Xr strxfrm 3 ,
	90	.Xr tolower 3
e9ce8d39 A	91	.Sh HISTORY
e9ce8d39 A	92	The
5b2abdfb A	93	.Fn strcasecmp
	94	and
	95	.Fn strncasecmp
	96	functions first appeared in
e9ce8d39	97	.Bx 4.4 .