original/man3/wcsnlen.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 .\"
  15 .TH WCSNLEN 3  2013-11-25 "GNU" "Linux Programmer's Manual"
  16 .SH NAME
  17 wcsnlen \- determine the length of a fixed-size wide-character string
  18 .SH SYNOPSIS
  19 .nf
  20 .B #include <wchar.h>
  21 .sp
  22 .BI "size_t wcsnlen(const wchar_t *" s ", size_t " maxlen );
  23 .fi
  24 .sp
  25 .in -4n
  26 Feature Test Macro Requirements for glibc (see
  27 .BR feature_test_macros (7)):
  28 .in
  29 .sp
  30 .BR wcsnlen ():
  31 .PD 0
  32 .ad l
  33 .RS 4
  34 .TP 4
  35 Since glibc 2.10:
  36 _XOPEN_SOURCE\ >=\ 700 || _POSIX_C_SOURCE\ >=\ 200809L
  37 .TP
  38 Before glibc 2.10:
  39 _GNU_SOURCE
  40 .RE
  41 .ad
  42 .PD
  43 .SH DESCRIPTION
  44 The
  45 .BR wcsnlen ()
  46 function is the wide-character equivalent
  47 of the
  48 .BR strnlen (3)
  49 function.
  50 It returns the number of wide-characters in the string pointed to by
  51 .IR s ,
  52 not including the terminating null wide character (L\(aq\\0\(aq),
  53 but at most
  54 .I maxlen
  55 wide characters (note: this parameter is not a byte count).
  56 In doing this,
  57 .BR wcsnlen ()
  58 looks at only the first
  59 .I maxlen
  60 wide characters at
  61 .I s
  62 and never beyond
  63 .IR s+maxlen .
  64 .SH RETURN VALUE
  65 The
  66 .BR wcsnlen ()
  67 function returns
  68 .IR wcslen(s) ,
  69 if that is less than
  70 .IR maxlen ,
  71 or
  72 .I maxlen
  73 if there is no null wide character among the
  74 first
  75 .I maxlen
  76 wide characters pointed to by
  77 .IR s .
  78 .SH VERSIONS
  79 The
  80 .BR wcsnlen ()
  81 function is provided in glibc since version 2.1.
  82 .SH ATTRIBUTES
  83 .SS Multithreading (see pthreads(7))
  84 The
  85 .BR wcsnlen ()
  86 function is thread-safe.
  87 .SH CONFORMING TO
  88 POSIX.1-2008.
  89 .SH SEE ALSO
  90 .BR strnlen (3),
  91 .BR wcslen (3)
  92 .SH COLOPHON
  93 This page is part of release 3.67 of the Linux
  94 .I man-pages
  95 project.
  96 A description of the project,
  97 information about reporting bugs,
  98 and the latest version of this page,
  99 can be found at
 100 \%http://www.kernel.org/doc/man\-pages/.