summaryrefslogtreecommitdiffstats
path: root/man-pages-posix-2017/man3p/wcslen.3p
blob: fed79fa499ee4f624149447458086b851cec4736 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
'\" et
.TH WCSLEN "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
.\"
.SH PROLOG
This manual page is part of the POSIX Programmer's Manual.
The Linux implementation of this interface may differ (consult
the corresponding Linux manual page for details of Linux behavior),
or the interface may not be implemented on Linux.
.\"
.SH NAME
wcslen, wcsnlen
\(em get length of a fixed-sized wide-character string
.SH SYNOPSIS
.LP
.nf
#include <wchar.h>
.P
size_t wcslen(const wchar_t *\fIws\fP);
size_t wcsnlen(const wchar_t *\fIws\fP, size_t \fImaxlen\fP);
.fi
.SH DESCRIPTION
For
\fIwcslen\fR():
The functionality described on this reference page is aligned with the
ISO\ C standard. Any conflict between the requirements described here and the
ISO\ C standard is unintentional. This volume of POSIX.1\(hy2017 defers to the ISO\ C standard.
.P
The
\fIwcslen\fR()
function shall compute the number of wide-character codes in the
wide-character string to which
.IR ws
points, not including the terminating null wide-character code.
.P
The
\fIwcsnlen\fR()
function shall compute the smaller of the number of wide characters in
the array to which
.IR ws
points, not including any terminating null wide-character code, and the
value of
.IR maxlen .
The
\fIwcsnlen\fR()
function shall never examine more than the first
.IR maxlen
characters of the wide-character array pointed to by
.IR ws .
.SH "RETURN VALUE"
The
\fIwcslen\fR()
function shall return the length of
.IR ws .
.P
The
\fIwcsnlen\fR()
function shall return the number of wide characters preceding the
first null wide-character code in the array to which
.IR ws
points, if
.IR ws
contains a null wide-character code within the first
.IR maxlen
wide characters; otherwise, it shall return
.IR maxlen .
.P
No return values are reserved to indicate an error.
.SH ERRORS
No errors are defined.
.LP
.IR "The following sections are informative."
.SH EXAMPLES
None.
.SH "APPLICATION USAGE"
None.
.SH RATIONALE
None.
.SH "FUTURE DIRECTIONS"
None.
.SH "SEE ALSO"
.IR "\fIstrlen\fR\^(\|)"
.P
The Base Definitions volume of POSIX.1\(hy2017,
.IR "\fB<wchar.h>\fP"
.\"
.SH COPYRIGHT
Portions of this text are reprinted and reproduced in electronic form
from IEEE Std 1003.1-2017, Standard for Information Technology
-- Portable Operating System Interface (POSIX), The Open Group Base
Specifications Issue 7, 2018 Edition,
Copyright (C) 2018 by the Institute of
Electrical and Electronics Engineers, Inc and The Open Group.
In the event of any discrepancy between this version and the original IEEE and
The Open Group Standard, the original IEEE and The Open Group Standard
is the referee document. The original Standard can be obtained online at
http://www.opengroup.org/unix/online.html .
.PP
Any typographical or formatting errors that appear
in this page are most likely
to have been introduced during the conversion of the source files to
man page format. To report such errors, see
https://www.kernel.org/doc/man-pages/reporting_bugs.html .