summaryrefslogtreecommitdiffstats
path: root/man-pages-posix-2017/man3p/strlen.3p
blob: 6082b6e0c1af68b36d65815d051f94d2e4e50d1a (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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
'\" et
.TH STRLEN "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
strlen, strnlen
\(em get length of fixed size string
.SH SYNOPSIS
.LP
.nf
#include <string.h>
.P
size_t strlen(const char *\fIs\fP);
size_t strnlen(const char *\fIs\fP, size_t \fImaxlen\fP);
.fi
.SH DESCRIPTION
For
\fIstrlen\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
\fIstrlen\fR()
function shall compute the number of bytes in the string to which
.IR s
points, not including the terminating NUL character.
.P
The
\fIstrnlen\fR()
function shall compute the smaller of the number of bytes in the array
to which
.IR s
points, not including any terminating NUL character, or the value of the
.IR maxlen
argument. The
\fIstrnlen\fR()
function shall never examine more than
.IR maxlen
bytes of the array pointed to by
.IR s .
.SH "RETURN VALUE"
The
\fIstrlen\fR()
function shall return the length of
.IR s ;
no return value shall be reserved to indicate an error.
.P
The
\fIstrnlen\fR()
function shall return the number of bytes preceding the first null
byte in the array to which
.IR s
points, if
.IR s
contains a null byte within the first
.IR maxlen
bytes; otherwise, it shall return
.IR maxlen .
.SH ERRORS
No errors are defined.
.LP
.IR "The following sections are informative."
.SH EXAMPLES
.SS "Getting String Lengths"
.P
The following example sets the maximum length of
.IR key
and
.IR data
by using
\fIstrlen\fR()
to get the lengths of those strings.
.sp
.RS 4
.nf

#include <string.h>
\&...
struct element {
    char *key;
    char *data;
};
\&...
char *key, *data;
int len;
.P
*keylength = *datalength = 0;
\&...
if ((len = strlen(key)) > *keylength)
    *keylength = len;
if ((len = strlen(data)) > *datalength)
    *datalength = len;
\&...
.fi
.P
.RE
.SH "APPLICATION USAGE"
None.
.SH RATIONALE
None.
.SH "FUTURE DIRECTIONS"
None.
.SH "SEE ALSO"
.IR "\fIwcslen\fR\^(\|)"
.P
The Base Definitions volume of POSIX.1\(hy2017,
.IR "\fB<string.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 .