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  2011-10-01 "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 \fIs\fP, not including the terminating null wide character (L\(aq\\0\(aq),
  52 but at most
  53 \fImaxlen\fP
  54 wide characters (note: this parameter is not a byte count).
  55 In doing this,
  56 .BR wcsnlen ()
  57 looks at only the first \fImaxlen\fP
  58 wide characters at \fIs\fP and never beyond \fIs+maxlen\fP.
  59 .SH RETURN VALUE
  60 The
  61 .BR wcsnlen ()
  62 function returns \fIwcslen(s)\fP, if that is less than
  63 \fImaxlen\fP, or \fImaxlen\fP if there is no null wide character among the
  64 first \fImaxlen\fP wide characters pointed to by \fIs\fP.
  65 .SH VERSIONS
  66 The
  67 .BR wcsnlen ()
  68 function is provided in glibc since version 2.1.
  69 .SH CONFORMING TO
  70 POSIX.1-2008.
  71 .SH SEE ALSO
  72 .BR strnlen (3),
  73 .BR wcslen (3)