string/FreeBSD/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 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)strcspn.3   8.1 (Berkeley) 6/4/93
  33 .\" $FreeBSD: src/lib/libc/string/strcspn.3,v 1.9 2007/01/09 00:28:12 imp Exp $
  34 .\"
  35 .Dd June 4, 1993
  36 .Dt STRCSPN 3
  37 .Os
  38 .Sh NAME
  39 .Nm strcspn
  40 .Nd span the complement of a string
  41 .Sh LIBRARY
  42 .Lb libc
  43 .Sh SYNOPSIS
  44 .In string.h
  45 .Ft size_t
  46 .Fo strcspn
  47 .Fa "const char *s1"
  48 .Fa "const char *s2"
  49 .Fc
  50 .Sh DESCRIPTION
  51 The
  52 .Fn strcspn
  53 function
  54 spans the initial part of the null-terminated string
  55 .Fa s1 ,
  56 as long as the characters from
  57 .Fa s1
  58 do not occur in string
  59 .Fa s2
  60 (it
  61 spans the
  62 .Em complement
  63 of
  64 .Fa s2 ) .
  65 In other words, it computes the string array index in
  66 .Fa s1
  67 of the first character of
  68 .Fa s1
  69 which is also in
  70 .Fa s2 ,
  71 else the index of the first null character.
  72 .Sh RETURN VALUES
  73 The
  74 .Fn strcspn
  75 function
  76 returns the number of characters spanned.
  77 .Sh SEE ALSO
  78 .Xr memchr 3 ,
  79 .Xr strchr 3 ,
  80 .Xr strpbrk 3 ,
  81 .Xr strrchr 3 ,
  82 .Xr strsep 3 ,
  83 .Xr strspn 3 ,
  84 .Xr strstr 3 ,
  85 .Xr strtok 3
  86 .Sh STANDARDS
  87 The
  88 .Fn strcspn
  89 function
  90 conforms to
  91 .St -isoC .