1.\" $OpenBSD: wcslen.3,v 1.4 2024/07/14 09:51:18 jca Exp $ 2.\" 3.\" Copyright (c) 1990, 1991 The Regents of the University of California. 4.\" All rights reserved. 5.\" 6.\" This code is derived from software contributed to Berkeley by 7.\" Chris Torek and the American National Standards Committee X3, 8.\" on Information Processing Systems. 9.\" 10.\" Redistribution and use in source and binary forms, with or without 11.\" modification, are permitted provided that the following conditions 12.\" are met: 13.\" 1. Redistributions of source code must retain the above copyright 14.\" notice, this list of conditions and the following disclaimer. 15.\" 2. Redistributions in binary form must reproduce the above copyright 16.\" notice, this list of conditions and the following disclaimer in the 17.\" documentation and/or other materials provided with the distribution. 18.\" 3. Neither the name of the University nor the names of its contributors 19.\" may be used to endorse or promote products derived from this software 20.\" without specific prior written permission. 21.\" 22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32.\" SUCH DAMAGE. 33.\" 34.Dd $Mdocdate: July 14 2024 $ 35.Dt WCSLEN 3 36.Os 37.Sh NAME 38.Nm wcslen , 39.Nm wcsnlen 40.Nd find length of a wide string 41.Sh SYNOPSIS 42.In wchar.h 43.Ft size_t 44.Fn wcslen "const wchar_t *s" 45.Ft size_t 46.Fn wcsnlen "const wchar_t *s" "size_t maxlen" 47.Sh DESCRIPTION 48The 49.Fn wcslen 50function computes the length of the wide string 51.Fa s . 52The 53.Fn wcsnlen 54function computes the length of the wide string 55.Fa s , 56up to 57.Fa maxlen 58wide characters. 59The 60.Fn wcsnlen 61function will never attempt to address more than 62.Fa maxlen 63wide characters, making it suitable for use with wide character arrays 64that are not guaranteed to be NUL-terminated. 65.Sh RETURN VALUES 66The 67.Fn wcslen 68function returns the number of wide characters that precede the terminating 69null wide character. 70.Pp 71The 72.Fn wcsnlen 73function returns the number of wide characters that precede the terminating 74null wide character 75or 76.Fa maxlen , 77whichever is smaller. 78.Sh SEE ALSO 79.Xr strlen 3 , 80.Xr wcswidth 3 81.Sh STANDARDS 82The 83.Fn wcslen 84function conforms to 85.St -isoC-99 86and was first introduced in 87.St -isoC-amd1 . 88The 89.Fn wcsnlen 90function conforms to 91.St -p1003.1-2008 . 92.Sh HISTORY 93The 94.Fn wcslen 95function was ported from 96.Nx 97and first appeared in 98.Ox 3.8 . 99The 100.Fn wcsnlen 101function first appeared in 102.Ox 7.6 . 103