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
|
|
|
|
.\" Dinkumware C library reference http://www.dinkumware.com/
|
|
|
|
.\" OpenGroup's Single Unix specification http://www.UNIX-systems.org/online.html
|
|
|
|
.\"
|
accept.2, clone.2, dup.2, fallocate.2, pipe.2, readahead.2, sched_setaffinity.2, unshare.2, CPU_SET.3, endian.3, euidaccess.3, fexecve.3, getpt.3, getpw.3, getumask.3, getutmp.3, gnu_get_libc_version.3, makedev.3, matherr.3, mbsnrtowcs.3, memfrob.3, pthread_attr_setaffinity_np.3, pthread_getattr_np.3, pthread_setaffinity_np.3, pthread_tryjoin_np.3, tcgetsid.3, wcscasecmp.3, wcsncasecmp.3, wcsnlen.3, wcsnrtombs.3, wcswidth.3, rtld-audit.7: SYNOPSIS: Add reference to feature_test_macros(7)
These pages specify feature test macros in the function
prototypes. Add a reference to feature_test_macros(7),
so that readers are pointed to the information that
feature test macros must be defined before including
*any* header file.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-09-10 05:06:22 +00:00
|
|
|
.TH WCSNLEN 3 2010-09-10 "GNU" "Linux Programmer's Manual"
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH NAME
|
|
|
|
wcsnlen \- determine the length of a fixed-size wide-character string
|
|
|
|
.SH SYNOPSIS
|
|
|
|
.nf
|
accept.2, clone.2, dup.2, fallocate.2, pipe.2, readahead.2, sched_setaffinity.2, unshare.2, CPU_SET.3, endian.3, euidaccess.3, fexecve.3, getpt.3, getpw.3, getumask.3, getutmp.3, gnu_get_libc_version.3, makedev.3, matherr.3, mbsnrtowcs.3, memfrob.3, pthread_attr_setaffinity_np.3, pthread_getattr_np.3, pthread_setaffinity_np.3, pthread_tryjoin_np.3, tcgetsid.3, wcscasecmp.3, wcsncasecmp.3, wcsnlen.3, wcsnrtombs.3, wcswidth.3, rtld-audit.7: SYNOPSIS: Add reference to feature_test_macros(7)
These pages specify feature test macros in the function
prototypes. Add a reference to feature_test_macros(7),
so that readers are pointed to the information that
feature test macros must be defined before including
*any* header file.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-09-10 05:06:22 +00:00
|
|
|
.BR "#define _GNU_SOURCE" " /* See feature_test_macros(7) */"
|
2004-11-03 13:51:07 +00:00
|
|
|
.B #include <wchar.h>
|
|
|
|
.sp
|
|
|
|
.BI "size_t wcsnlen(const wchar_t *" s ", size_t " maxlen );
|
|
|
|
.fi
|
|
|
|
.SH DESCRIPTION
|
2007-05-12 09:06:04 +00:00
|
|
|
The
|
|
|
|
.BR wcsnlen ()
|
|
|
|
function is the wide-character equivalent
|
|
|
|
of the
|
|
|
|
.BR strnlen (3)
|
|
|
|
function.
|
2007-04-12 22:42:49 +00:00
|
|
|
It returns the number of wide-characters in the string pointed to by
|
2008-06-09 15:49:35 +00:00
|
|
|
\fIs\fP, not including the terminating L\(aq\\0\(aq character, but at most
|
2007-04-12 22:42:49 +00:00
|
|
|
\fImaxlen\fP.
|
2007-05-12 09:06:04 +00:00
|
|
|
In doing this,
|
|
|
|
.BR wcsnlen ()
|
|
|
|
looks only at the first \fImaxlen\fP
|
2004-11-03 13:51:07 +00:00
|
|
|
wide-characters at \fIs\fP and never beyond \fIs+maxlen\fP.
|
|
|
|
.SH "RETURN VALUE"
|
2007-05-12 09:06:04 +00:00
|
|
|
The
|
|
|
|
.BR wcsnlen ()
|
|
|
|
function returns \fIwcslen(s)\fP, if that is less than
|
2008-06-09 15:49:35 +00:00
|
|
|
\fImaxlen\fP, or \fImaxlen\fP if there is no L\(aq\\0\(aq character among the
|
2004-11-03 13:51:07 +00:00
|
|
|
first \fImaxlen\fP wide characters pointed to by \fIs\fP.
|
|
|
|
.SH "CONFORMING TO"
|
|
|
|
This function is a GNU extension.
|
|
|
|
.SH "SEE ALSO"
|
|
|
|
.BR strnlen (3),
|
|
|
|
.BR wcslen (3)
|