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  2021-03-22 "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 .PP
  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
  33 .I wcs
  34 which consists entirely of wide-characters not listed in
  35 .IR reject .
  36 In
  37 other words, it searches for the first occurrence in the wide-character
  38 string
  39 .I wcs
  40 of any of the characters in the wide-character string
  41 .IR reject .
  42 .SH RETURN VALUE
  43 The
  44 .BR wcscspn ()
  45 function returns the number of
  46 wide characters in the longest
  47 initial segment of
  48 .I wcs
  49 which consists entirely of wide-characters not
  50 listed in
  51 .IR reject .
  52 In other words, it returns the position of the first
  53 occurrence in the wide-character string
  54 .I wcs
  55 of any of the characters in
  56 the wide-character string
  57 .IR reject ,
  58 or
  59 .IR wcslen(wcs)
  60 if there is none.
  61 .SH ATTRIBUTES
  62 For an explanation of the terms used in this section, see
  63 .BR attributes (7).
  64 .ad l
  65 .nh
  66 .TS
  67 allbox;
  68 lbx lb lb
  69 l l l.
  70 Interface       Attribute       Value
  71 T{
  72 .BR wcscspn ()
  73 T}      Thread safety   MT-Safe
  74 .TE
  75 .hy
  76 .ad
  77 .sp 1
  78 .SH CONFORMING TO
  79 POSIX.1-2001, POSIX.1-2008, C99.
  80 .SH SEE ALSO
  81 .BR strcspn (3),
  82 .BR wcspbrk (3),
  83 .BR wcsspn (3)