original/man3/wcscspn.3

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