man3/wcsspn.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 WCSSPN 3  2015-08-08 "GNU" "Linux Programmer's Manual"
  17 .SH NAME
  18 wcsspn \- advance in a wide-character string, skipping
  19 any of a set of wide characters
  20 .SH SYNOPSIS
  21 .nf
  22 .B #include <wchar.h>
  23 .PP
  24 .BI "size_t wcsspn(const wchar_t *" wcs ", const wchar_t *" accept );
  25 .fi
  26 .SH DESCRIPTION
  27 The
  28 .BR wcsspn ()
  29 function is the wide-character equivalent of the
  30 .BR strspn (3)
  31 function.
  32 It determines the length of the longest initial segment of
  33 .I wcs
  34 which consists entirely of wide-characters listed in
  35 .IR accept .
  36 In other
  37 words, it searches for the first occurrence in the wide-character string
  38 .I wcs
  39 of a wide-character not contained in the wide-character string
  40 .IR accept .
  41 .SH RETURN VALUE
  42 The
  43 .BR wcsspn ()
  44 function returns the number of
  45 wide characters in the longest
  46 initial segment of
  47 .I wcs
  48 which consists entirely of wide-characters listed
  49 in
  50 .IR accept .
  51 In other words, it returns the position of the first
  52 occurrence in the wide-character string
  53 .I wcs
  54 of a wide-character not
  55 contained in the wide-character string
  56 .IR accept ,
  57 or
  58 .I wcslen(wcs)
  59 if there is none.
  60 .SH ATTRIBUTES
  61 For an explanation of the terms used in this section, see
  62 .BR attributes (7).
  63 .TS
  64 allbox;
  65 lb lb lb
  66 l l l.
  67 Interface       Attribute       Value
  68 T{
  69 .BR wcsspn ()
  70 T}      Thread safety   MT-Safe
  71 .TE
  72 .SH CONFORMING TO
  73 POSIX.1-2001, POSIX.1-2008, C99.
  74 .SH SEE ALSO
  75 .BR strspn (3),
  76 .BR wcscspn (3)