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