2004-11-03 13:51:07 +00:00
|
|
|
.\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
|
|
|
|
.\"
|
|
|
|
.\" This is free documentation; you can redistribute it and/or
|
|
|
|
.\" modify it under the terms of the GNU General Public License as
|
|
|
|
.\" published by the Free Software Foundation; either version 2 of
|
|
|
|
.\" the License, or (at your option) any later version.
|
|
|
|
.\"
|
|
|
|
.\" References consulted:
|
|
|
|
.\" GNU glibc-2 source code and manual
|
|
|
|
.\"
|
|
|
|
.TH STRNLEN 3 1999-07-25 "GNU" "Linux Programmer's Manual"
|
|
|
|
.SH NAME
|
|
|
|
strnlen \- determine the length of a fixed-size string
|
|
|
|
.SH SYNOPSIS
|
|
|
|
.nf
|
2005-09-15 12:40:42 +00:00
|
|
|
.B #define _GNU_SOURCE
|
|
|
|
.sp
|
2004-11-03 13:51:07 +00:00
|
|
|
.B #include <string.h>
|
|
|
|
.sp
|
|
|
|
.BI "size_t strnlen(const char *" s ", size_t " maxlen );
|
|
|
|
.fi
|
|
|
|
.SH DESCRIPTION
|
2005-10-19 06:54:38 +00:00
|
|
|
The \fBstrnlen\fP() function returns the number of characters in the string
|
2004-11-03 13:51:07 +00:00
|
|
|
pointed to by \fIs\fP, not including the terminating '\\0' character, but
|
2005-10-19 06:54:38 +00:00
|
|
|
at most \fImaxlen\fP. In doing this, \fBstrnlen\fP() looks only at the first
|
2004-11-03 13:51:07 +00:00
|
|
|
\fImaxlen\fP characters at \fIs\fP and never beyond \fIs+maxlen\fP.
|
|
|
|
.SH "RETURN VALUE"
|
2005-10-19 06:54:38 +00:00
|
|
|
The \fBstrnlen\fP() function returns \fIstrlen(s)\fP, if that is less than
|
2004-11-03 13:51:07 +00:00
|
|
|
\fImaxlen\fP, or \fImaxlen\fP if there is no '\\0' character among the first
|
|
|
|
\fImaxlen\fP characters pointed to by \fIs\fP.
|
|
|
|
.SH "CONFORMING TO"
|
|
|
|
This function is a GNU extension.
|
|
|
|
.SH "SEE ALSO"
|
|
|
|
.BR strlen (3)
|