diff options
Diffstat (limited to 'src/lib/libc/string/strspn.3')
-rw-r--r-- | src/lib/libc/string/strspn.3 | 88 |
1 files changed, 88 insertions, 0 deletions
diff --git a/src/lib/libc/string/strspn.3 b/src/lib/libc/string/strspn.3 new file mode 100644 index 0000000000..ca965aeb18 --- /dev/null +++ b/src/lib/libc/string/strspn.3 | |||
@@ -0,0 +1,88 @@ | |||
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. All advertising materials mentioning features or use of this software | ||
17 | .\" must display the following acknowledgement: | ||
18 | .\" This product includes software developed by the University of | ||
19 | .\" California, Berkeley and its contributors. | ||
20 | .\" 4. Neither the name of the University nor the names of its contributors | ||
21 | .\" may be used to endorse or promote products derived from this software | ||
22 | .\" without specific prior written permission. | ||
23 | .\" | ||
24 | .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND | ||
25 | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
26 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | ||
27 | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE | ||
28 | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | ||
29 | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | ||
30 | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||
31 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | ||
32 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | ||
33 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | ||
34 | .\" SUCH DAMAGE. | ||
35 | .\" | ||
36 | .\" $OpenBSD: strspn.3,v 1.6 2000/04/21 15:24:20 aaron Exp $ | ||
37 | .\" | ||
38 | .Dd June 29, 1991 | ||
39 | .Dt STRSPN 3 | ||
40 | .Os | ||
41 | .Sh NAME | ||
42 | .Nm strspn | ||
43 | .Nd span a string | ||
44 | .Sh SYNOPSIS | ||
45 | .Fd #include <string.h> | ||
46 | .Ft size_t | ||
47 | .Fn strspn "const char *s" "const char *charset" | ||
48 | .Sh DESCRIPTION | ||
49 | The | ||
50 | .Fn strspn | ||
51 | function spans the initial part of the null-terminated string | ||
52 | .Fa s | ||
53 | as long as the characters from | ||
54 | .Fa s | ||
55 | occur in string | ||
56 | .Fa charset . | ||
57 | .Sh RETURN VALUES | ||
58 | The | ||
59 | .Fn strspn | ||
60 | function returns the number of characters spanned. | ||
61 | .Sh EXAMPLES | ||
62 | The following call to | ||
63 | .Fn strspn | ||
64 | will return 3, since the first three characters of string | ||
65 | .Fa s | ||
66 | are part of string | ||
67 | .Fa charset : | ||
68 | .Bd -literal -offset indent | ||
69 | char *s = "foobar"; | ||
70 | char *charset = "of"; | ||
71 | size_t span; | ||
72 | |||
73 | span = strspn(s, charset); | ||
74 | .Ed | ||
75 | .Sh SEE ALSO | ||
76 | .Xr memchr 3 , | ||
77 | .Xr strchr 3 , | ||
78 | .Xr strcspn 3 , | ||
79 | .Xr strpbrk 3 , | ||
80 | .Xr strrchr 3 , | ||
81 | .Xr strsep 3 , | ||
82 | .Xr strstr 3 , | ||
83 | .Xr strtok 3 | ||
84 | .Sh STANDARDS | ||
85 | The | ||
86 | .Fn strspn | ||
87 | function conforms to | ||
88 | .St -ansiC . | ||