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
|
|
|
|
|
.\"
|
2010-09-15 06:55:09 +00:00
|
|
|
.TH STRNLEN 3 2010-09-15 "GNU" "Linux Programmer's Manual"
|
2004-11-03 13:51:07 +00:00
|
|
|
.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
|
2010-09-15 06:55:09 +00:00
|
|
|
.sp
|
|
|
|
|
.in -4n
|
|
|
|
|
Feature Test Macro Requirements for glibc (see
|
|
|
|
|
.BR feature_test_macros (7)):
|
|
|
|
|
.in
|
|
|
|
|
.sp
|
|
|
|
|
.BR strnlen ():
|
|
|
|
|
.br
|
brk.2, chroot.2, faccessat.2, fchmodat.2, fchownat.2, fstatat.2, futimesat.2, getdtablesize.2, getpagesize.2, getsid.2, linkat.2, mkdirat.2, mknodat.2, openat.2, pread.2, readlinkat.2, renameat.2, setpgid.2, sigaltstack.2, symlinkat.2, sync.2, timer_create.2, timer_delete.2, timer_getoverrun.2, timer_settime.2, unlinkat.2, utimensat.2, vfork.2, acosh.3, asinh.3, atanh.3, dirfd.3, dprintf.3, ecvt.3, expm1.3, fexecve.3, fmemopen.3, gcvt.3, getcwd.3, gethostid.3, getpass.3, getsubopt.3, getw.3, mbsnrtowcs.3, mkfifoat.3, mkstemp.3, mktemp.3, opendir.3, posix_memalign.3, rint.3, siginterrupt.3, stpcpy.3, stpncpy.3, strdup.3, strerror.3, strnlen.3, strsignal.3, strtol.3, strtoul.3, ualarm.3, usleep.3, wcpcpy.3, wcpncpy.3, wcscasecmp.3, wcsdup.3, wcsncasecmp.3, wcsnlen.3, wcsnrtombs.3: ffix
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-09-19 06:02:38 +00:00
|
|
|
Since glibc 2.10: _POSIX_C_SOURCE\ >=\ 200809L || _XOPEN_SOURCE\ >=\ 700
|
2010-09-15 06:55:09 +00:00
|
|
|
.br
|
|
|
|
|
Before glibc 2.10:
|
|
|
|
|
_GNU_SOURCE
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH DESCRIPTION
|
2007-05-12 09:06:04 +00:00
|
|
|
The
|
|
|
|
|
.BR strnlen ()
|
|
|
|
|
function returns the number of characters in the string
|
2008-06-09 15:49:35 +00:00
|
|
|
pointed to by \fIs\fP, not including the terminating \(aq\\0\(aq character,
|
|
|
|
|
but at most \fImaxlen\fP.
|
2007-05-12 09:06:04 +00:00
|
|
|
In doing this,
|
|
|
|
|
.BR strnlen ()
|
|
|
|
|
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"
|
2007-05-12 09:06:04 +00:00
|
|
|
The
|
|
|
|
|
.BR strnlen ()
|
|
|
|
|
function returns \fIstrlen(s)\fP, if that is less than
|
2008-06-09 15:49:35 +00:00
|
|
|
\fImaxlen\fP, or \fImaxlen\fP
|
|
|
|
|
if there is no \(aq\\0\(aq character among the first
|
2004-11-03 13:51:07 +00:00
|
|
|
\fImaxlen\fP characters pointed to by \fIs\fP.
|
|
|
|
|
.SH "CONFORMING TO"
|
|
|
|
|
This function is a GNU extension.
|
|
|
|
|
.SH "SEE ALSO"
|
2007-01-28 20:00:24 +00:00
|
|
|
.BR strlen (3),
|
|
|
|
|
.BR feature_test_macros (7)
|
