lib/libc/string/strcspn.3

   1 .\" Copyright (c) 1990, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" This code is derived from software contributed to Berkeley by
   5 .\" Chris Torek and the American National Standards Committee X3,
   6 .\" on Information Processing Systems.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 3. All advertising materials mentioning features or use of this software
  17 .\"    must display the following acknowledgement:
  18 .\"     This product includes software developed by the University of
  19 .\"     California, Berkeley and its contributors.
  20 .\" 4. Neither the name of the University nor the names of its contributors
  21 .\"    may be used to endorse or promote products derived from this software
  22 .\"    without specific prior written permission.
  23 .\"
  24 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34 .\" SUCH DAMAGE.
  35 .\"
  36 .\"     @(#)strcspn.3   8.1 (Berkeley) 6/4/93
  37 .\" $FreeBSD: src/lib/libc/string/strcspn.3,v 1.3.2.4 2001/12/14 18:33:59 ru Exp $
  38 .\" $DragonFly: src/lib/libc/string/strcspn.3,v 1.2 2003/06/17 04:26:46 dillon Exp $
  39 .\"
  40 .Dd June 4, 1993
  41 .Dt STRCSPN 3
  42 .Os
  43 .Sh NAME
  44 .Nm strcspn
  45 .Nd span the complement of a string
  46 .Sh LIBRARY
  47 .Lb libc
  48 .Sh SYNOPSIS
  49 .In string.h
  50 .Ft size_t
  51 .Fn strcspn "const char *s" "const char *charset"
  52 .Sh DESCRIPTION
  53 The
  54 .Fn strcspn
  55 function
  56 spans the initial part of the null-terminated string
  57 .Fa s
  58 as long as the characters from
  59 .Fa s
  60 do not occur in string
  61 .Fa charset
  62 (it
  63 spans the
  64 .Em complement
  65 of
  66 .Fa charset ) .
  67 .Sh RETURN VALUES
  68 The
  69 .Fn strcspn
  70 function
  71 returns the number of characters spanned.
  72 .Sh SEE ALSO
  73 .Xr memchr 3 ,
  74 .Xr strchr 3 ,
  75 .Xr strpbrk 3 ,
  76 .Xr strrchr 3 ,
  77 .Xr strsep 3 ,
  78 .Xr strspn 3 ,
  79 .Xr strstr 3 ,
  80 .Xr strtok 3
  81 .Sh STANDARDS
  82 The
  83 .Fn strcspn
  84 function
  85 conforms to
  86 .St -isoC .