projects / thirdparty / man-pages.git / blame
| Commit | Line | Data |
|---|---|---|
| fea681da MK |
1 | .\" Copyright (c) Bruno Haible <haible@clisp.cons.org> |
| 2 | .\" | |
| 89e3ffe9 | 3 | .\" %%%LICENSE_START(GPLv2+_DOC_ONEPARA) |
| fea681da MK |
4 | .\" This is free documentation; you can redistribute it and/or |
| 5 | .\" modify it under the terms of the GNU General Public License as | |
| 6 | .\" published by the Free Software Foundation; either version 2 of | |
| 7 | .\" the License, or (at your option) any later version. | |
| fe382ebf | 8 | .\" %%%LICENSE_END |
| fea681da MK |
9 | .\" |
| 10 | .\" References consulted: | |
| 11 | .\" GNU glibc-2 source code and manual | |
| 12 | .\" Dinkumware C library reference http://www.dinkumware.com/ | |
| 008f1ecc | 13 | .\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html |
| fea681da | 14 | .\" |
| 9ba01802 | 15 | .TH WCSNLEN 3 2019-03-06 "GNU" "Linux Programmer's Manual" |
| fea681da MK |
16 | .SH NAME |
| 17 | wcsnlen \- determine the length of a fixed-size wide-character string | |
| 18 | .SH SYNOPSIS | |
| 19 | .nf | |
| 20 | .B #include <wchar.h> | |
| 68e4db0a | 21 | .PP |
| fea681da MK |
22 | .BI "size_t wcsnlen(const wchar_t *" s ", size_t " maxlen ); |
| 23 | .fi | |
| 68e4db0a | 24 | .PP |
| b21b5bc2 MK |
25 | .in -4n |
| 26 | Feature Test Macro Requirements for glibc (see | |
| 27 | .BR feature_test_macros (7)): | |
| 28 | .in | |
| 68e4db0a | 29 | .PP |
| b21b5bc2 | 30 | .BR wcsnlen (): |
| ea91c3fd MK |
31 | .PD 0 |
| 32 | .ad l | |
| 33 | .RS 4 | |
| 34 | .TP 4 | |
| 35 | Since glibc 2.10: | |
| b0da7b8b | 36 | _POSIX_C_SOURCE\ >=\ 200809L |
| ea91c3fd | 37 | .TP |
| b21b5bc2 MK |
38 | Before glibc 2.10: |
| 39 | _GNU_SOURCE | |
| ea91c3fd MK |
40 | .RE |
| 41 | .ad | |
| 42 | .PD | |
| fea681da | 43 | .SH DESCRIPTION |
| 60a90ecd MK |
44 | The |
| 45 | .BR wcsnlen () | |
| 46 | function is the wide-character equivalent | |
| 47 | of the | |
| 48 | .BR strnlen (3) | |
| 49 | function. | |
| c13182ef | 50 | It returns the number of wide-characters in the string pointed to by |
| 40aa0db0 | 51 | .IR s , |
| d1a71985 | 52 | not including the terminating null wide character (L\(aq\e0\(aq), |
| e9c23bc6 | 53 | but at most |
| 40aa0db0 | 54 | .I maxlen |
| 1c1c2c10 | 55 | wide characters (note: this parameter is not a byte count). |
| 60a90ecd MK |
56 | In doing this, |
| 57 | .BR wcsnlen () | |
| 40aa0db0 MK |
58 | looks at only the first |
| 59 | .I maxlen | |
| 60 | wide characters at | |
| 61 | .I s | |
| 62 | and never beyond | |
| 63 | .IR s+maxlen . | |
| 47297adb | 64 | .SH RETURN VALUE |
| 60a90ecd MK |
65 | The |
| 66 | .BR wcsnlen () | |
| 40aa0db0 MK |
67 | function returns |
| 68 | .IR wcslen(s) , | |
| 69 | if that is less than | |
| 70 | .IR maxlen , | |
| 71 | or | |
| 72 | .I maxlen | |
| 73 | if there is no null wide character among the | |
| 74 | first | |
| 75 | .I maxlen | |
| 76 | wide characters pointed to by | |
| 77 | .IR s . | |
| e4731aab MK |
78 | .SH VERSIONS |
| 79 | The | |
| 80 | .BR wcsnlen () | |
| 81 | function is provided in glibc since version 2.1. | |
| f4fe579b | 82 | .SH ATTRIBUTES |
| 289e994a PH |
83 | For an explanation of the terms used in this section, see |
| 84 | .BR attributes (7). | |
| 85 | .TS | |
| 86 | allbox; | |
| 87 | lb lb lb | |
| 88 | l l l. | |
| 89 | Interface Attribute Value | |
| 90 | T{ | |
| f4fe579b | 91 | .BR wcsnlen () |
| 289e994a PH |
92 | T} Thread safety MT-Safe |
| 93 | .TE | |
| 47297adb | 94 | .SH CONFORMING TO |
| d9a8bda4 | 95 | POSIX.1-2008. |
| 47297adb | 96 | .SH SEE ALSO |
| fea681da MK |
97 | .BR strnlen (3), |
| 98 | .BR wcslen (3) |