lib/libc/string/strlen.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. 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 .\"     from: @(#)strlen.3      8.1 (Berkeley) 6/4/93
  33 .\"     $NetBSD: strlen.3,v 1.9 2009/05/01 17:27:01 perry Exp $
  34 .\"
  35 .Dd May 1, 2009
  36 .Dt STRLEN 3
  37 .Os
  38 .Sh NAME
  39 .Nm strlen ,
  40 .Nm strnlen
  41 .Nd find length of string
  42 .Sh LIBRARY
  43 .Lb libc
  44 .Sh SYNOPSIS
  45 .In string.h
  46 .Ft size_t
  47 .Fn strlen "const char *s"
  48 .Ft size_t
  49 .Fn strnlen "const char *s" "size_t maxlen"
  50 .Sh DESCRIPTION
  51 The
  52 .Fn strlen
  53 function
  54 computes the length of the string
  55 .Fa s .
  56 .Pp
  57 The
  58 .Fn strnlen
  59 function attempts to compute the length of
  60 .Fa s ,
  61 but never scans beyond the first
  62 .Fa maxlen
  63 bytes of
  64 .Fa s .
  65 .Sh RETURN VALUES
  66 The
  67 .Fn strlen
  68 function
  69 returns
  70 the number of characters that precede the
  71 terminating
  72 .Dv NUL
  73 character.
  74 .Pp
  75 The
  76 .Fn strnlen
  77 function returns either the same result as
  78 .Fn strlen
  79 or
  80 .Fa maxlen ,
  81 whichever is smaller.
  82 .Sh SEE ALSO
  83 .Xr string 3 ,
  84 .Xr wcslen 3 ,
  85 .Xr wcswidth 3
  86 .Sh STANDARDS
  87 The
  88 .Fn strlen
  89 function
  90 conforms to
  91 .St -isoC .
  92 The
  93 .Fn strnlen
  94 function conforms to
  95 .St -p1003.1-2008 .