aboutsummaryrefslogtreecommitdiffstats
path: root/man3/wcsspn.3
blob: 435f0b7b94926986b891cee320b3e766c0e4fdf3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
.\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
.\"
.\" This is free documentation; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License as
.\" published by the Free Software Foundation; either version 2 of
.\" the License, or (at your option) any later version.
.\"
.\" References consulted:
.\"   GNU glibc-2 source code and manual
.\"   Dinkumware C library reference http://www.dinkumware.com/
.\"   OpenGroup's Single Unix specification http://www.UNIX-systems.org/online.html
.\"   ISO/IEC 9899:1999
.\"
.TH WCSSPN 3  1999-07-25 "GNU" "Linux Programmer's Manual"
.SH NAME
wcsspn \- advance in a wide-character string, skipping
any of a set of wide characters
.SH SYNOPSIS
.nf
.B #include <wchar.h>
.sp
.BI "wcsspn(const wchar_t *" wcs ", const wchar_t *" accept );
.fi
.SH DESCRIPTION
The
.BR wcsspn ()
function is the wide-character equivalent of the
.BR strspn (3)
function.
It determines the length of the longest initial segment of \fIwcs\fP
which consists entirely of wide-characters listed in \fIaccept\fP.
In other
words, it searches for the first occurrence in the wide-character string
\fIwcs\fP of a wide-character not contained in the wide-character string
\fIaccept\fP.
.SH "RETURN VALUE"
The
.BR wcsspn ()
function returns the number of
wide characters in the longest
initial segment of \fIwcs\fP which consists entirely of wide-characters listed
in \fIaccept\fP.
In other words, it returns the position of the first
occurrence in the wide-character string \fIwcs\fP of a wide-character not
contained in the wide-character string \fIaccept\fP, or \fIwcslen(wcs)\fP
if there is none.
.SH "CONFORMING TO"
C99.
.SH "SEE ALSO"
.BR strspn (3),
.BR wcscspn (3)