xref: /netbsd/lib/libc/string/strcspn.3 (revision 6550d01e)
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.\" 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.\"     from: @(#)strcspn.3	8.1 (Berkeley) 6/4/93
33.\"	$NetBSD: strcspn.3,v 1.10 2006/10/16 08:48:45 wiz Exp $
34.\"
35.Dd August 11, 2002
36.Dt STRCSPN 3
37.Os
38.Sh NAME
39.Nm strcspn
40.Nd span the complement of a string
41.Sh LIBRARY
42.Lb libc
43.Sh SYNOPSIS
44.In string.h
45.Ft size_t
46.Fn strcspn "const char *s" "const char *charset"
47.Sh DESCRIPTION
48The
49.Fn strcspn
50function
51spans the initial part of the nul-terminated string
52.Fa s
53as long as the characters from
54.Fa s
55do not occur in string
56.Fa charset
57(it
58spans the
59.Em complement
60of
61.Fa charset ) .
62.Sh RETURN VALUES
63The
64.Fn strcspn
65function
66returns the number of characters spanned.
67.Sh EXAMPLES
68The following call to
69.Fn strcspn
70will return 3, since the first three characters of string
71.Fa s
72do not occur in string
73.Fa charset :
74.Bd -literal -offset indent
75char *s = "foobar";
76char *charset = "bar";
77size_t span;
78
79span = strcspn(s, charset);
80.Ed
81.Sh SEE ALSO
82.Xr index 3 ,
83.Xr memchr 3 ,
84.Xr rindex 3 ,
85.Xr strchr 3 ,
86.Xr strpbrk 3 ,
87.Xr strrchr 3 ,
88.Xr strsep 3 ,
89.Xr strspn 3 ,
90.Xr strstr 3 ,
91.Xr strtok 3
92.Sh STANDARDS
93The
94.Fn strcspn
95function
96conforms to
97.St -ansiC .
98