tsearch.3: NAME: add twalk_r
[man-pages.git] / man3 / wcslen.3
blob52c450c80549760f5dc07065b305b54152f56cad
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 .\"   ISO/IEC 9899:1999
15 .\"
16 .TH WCSLEN 3  2021-03-22 "GNU" "Linux Programmer's Manual"
17 .SH NAME
18 wcslen \- determine the length of a wide-character string
19 .SH SYNOPSIS
20 .nf
21 .B #include <wchar.h>
22 .PP
23 .BI "size_t wcslen(const wchar_t *" s );
24 .fi
25 .SH DESCRIPTION
26 The
27 .BR wcslen ()
28 function is the wide-character equivalent
29 of the
30 .BR strlen (3)
31 function.
32 It determines the length of the wide-character string pointed to
34 .IR s ,
35 excluding the terminating null wide character (L\(aq\e0\(aq).
36 .SH RETURN VALUE
37 The
38 .BR wcslen ()
39 function returns the
40 number of wide characters in
41 .IR s .
42 .SH ATTRIBUTES
43 For an explanation of the terms used in this section, see
44 .BR attributes (7).
45 .ad l
46 .nh
47 .TS
48 allbox;
49 lbx lb lb
50 l l l.
51 Interface       Attribute       Value
53 .BR wcslen ()
54 T}      Thread safety   MT-Safe
55 .TE
56 .hy
57 .ad
58 .sp 1
59 .SH CONFORMING TO
60 POSIX.1-2001, POSIX.1-2008, C99.
61 .SH NOTES
62 In cases where the input buffer may not contain
63 a terminating null wide character,
64 .BR wcsnlen (3)
65 should be used instead.
66 .SH SEE ALSO
67 .BR strlen (3)