1.\" $NetBSD: wmemchr.3,v 1.19 2024/11/01 16:36:58 nia Exp $ 2.\" 3.\" Copyright (c) 1990, 1991, 1993 4.\" The Regents of the University of California. 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.\" from: @(#)strcpy.3 8.1 (Berkeley) 6/4/93 35.\" 36.Dd July 30, 2023 37.Dt WMEMCHR 3 38.Os 39.Sh NAME 40.Nm wmemchr , 41.Nm wmemcmp , 42.Nm wmemcpy , 43.Nm wmemmove , 44.Nm wmempcpy , 45.Nm wmemset , 46.Nm wcscat , 47.Nm wcschr , 48.Nm wcscmp , 49.Nm wcscpy , 50.Nm wcscspn , 51.Nm wcslcat , 52.Nm wcslcpy , 53.Nm wcslen , 54.Nm wcsncat , 55.Nm wcsncmp , 56.Nm wcsncpy , 57.Nm wcsnlen , 58.Nm wcspbrk , 59.Nm wcsrchr , 60.Nm wcsspn , 61.Nm wcsstr , 62.Nm wcswcs 63.Nd wide-character string manipulation operations 64.Sh LIBRARY 65.Lb libc 66.Sh SYNOPSIS 67.In wchar.h 68.Ft wchar_t * 69.Fn wmemchr "const wchar_t *s" "wchar_t c" "size_t n" 70.Ft int 71.Fn wmemcmp "const wchar_t *s1" "const wchar_t *s2" "size_t n" 72.Ft wchar_t * 73.Fn wmemcpy "wchar_t * restrict s1" "const wchar_t * restrict s2" "size_t n" 74.Ft wchar_t * 75.Fn wmemmove "wchar_t *s1" "const wchar_t *s2" "size_t n" 76.Ft wchar_t * 77.Fn wmempcpy "wchar_t * restrict s1" "const wchar_t * restrict s2" "size_t n" 78.Ft wchar_t * 79.Fn wmemset "wchar_t *s" "wchar_t c" "size_t n" 80.Ft wchar_t * 81.Fn wcscat "wchar_t * restrict s1" "const wchar_t * restrict s2" 82.Ft wchar_t * 83.Fn wcschr "const wchar_t *s" "wchar_t c" 84.Ft int 85.Fn wcscmp "const wchar_t *s1" "const wchar_t *s2" 86.Ft wchar_t * 87.Fn wcscpy "wchar_t * restrict s1" "const wchar_t * restrict s2" 88.Ft size_t 89.Fn wcscspn "const wchar_t *s1" "const wchar_t *s2" 90.Ft size_t 91.Fn wcslcat "wchar_t *s1" "const wchar_t *s2" "size_t n" 92.Ft size_t 93.Fn wcslcpy "wchar_t *s1" "const wchar_t *s2" "size_t n" 94.Ft size_t 95.Fn wcslen "const wchar_t *s" 96.Ft wchar_t * 97.Fn wcsncat "wchar_t * restrict s1" "const wchar_t * restrict s2" "size_t n" 98.Ft int 99.Fn wcsncmp "const wchar_t *s1" "const wchar_t * s2" "size_t n" 100.Ft wchar_t * 101.Fn wcsncpy "wchar_t * restrict s1" "const wchar_t * restrict s2" "size_t n" 102.Ft size_t 103.Fn wcsnlen "const wchar_t *s" "size_t maxlen" 104.Ft wchar_t * 105.Fn wcspbrk "const wchar_t *s1" "const wchar_t *s2" 106.Ft wchar_t * 107.Fn wcsrchr "const wchar_t *s" "wchar_t c" 108.Ft size_t 109.Fn wcsspn "const wchar_t *s1" "const wchar_t *s2" 110.Ft wchar_t * 111.Fn wcsstr "const wchar_t *s1" "const wchar_t *s2" 112.Ft wchar_t * 113.Fn wcswcs "const wchar_t *s1" "const wchar_t *s2" 114.Sh DESCRIPTION 115These functions implement string manipulation operations over wide-character 116strings. 117For a detailed description, refer to the documents for the respective 118single-byte counterpart, such as 119.Xr memchr 3 . 120The 121.Fn wcswcs 122function is not a part of 123.St -isoC 124and 125.St -isoC-amd1 , 126the 127.Fn wcsstr 128function is strongly recommended to be used. 129.Sh SEE ALSO 130.Xr memchr 3 , 131.Xr memcmp 3 , 132.Xr memcpy 3 , 133.Xr memmove 3 , 134.Xr memset 3 , 135.Xr stpcpy 3 , 136.Xr stpncpy 3 , 137.Xr strcasecmp 3 , 138.Xr strcat 3 , 139.Xr strchr 3 , 140.Xr strcmp 3 , 141.Xr strcpy 3 , 142.Xr strcspn 3 , 143.Xr strdup 3 , 144.Xr strlcat 3 , 145.Xr strlcpy 3 , 146.Xr strlen 3 , 147.Xr strncat 3 , 148.Xr strncmp 3 , 149.Xr strncpy 3 , 150.Xr strnlen 3 , 151.Xr strpbrk 3 , 152.Xr strrchr 3 , 153.Xr strspn 3 , 154.Xr strstr 3 155.Sh STANDARDS 156The 157.Fn wmemchr , 158.Fn wmemcmp , 159.Fn wmemcpy , 160.Fn wmemmove , 161.Fn wmemset , 162.Fn wcscat , 163.Fn wcschr , 164.Fn wcscmp , 165.Fn wcscpy , 166.Fn wcscspn , 167.Fn wcslen , 168.Fn wcsncat , 169.Fn wcsncmp , 170.Fn wcsncpy , 171.Fn wcspbrk , 172.Fn wcsrchr , 173.Fn wcsspn 174and 175.Fn wcsstr 176functions were first introduced in 177.St -isoC-amd1 178and conform to 179.St -isoC-99 . 180Part of them: 181.Fn wmemmove , 182.Fn wcscat , 183.Fn wcscpy , 184.Fn wcsncat 185and 186.Fn wcsncpy 187were modified in 188.St -isoC-99 189and gained the 190.Dv restrict 191keyword in parameter list, 192this new version is present in 193.Nx . 194.Pp 195The 196.Fn wcswcs 197function conforms to 198.St -xpg4.2 , 199it is recommended to use technically equivalent 200.Fn wcsstr 201for maximum portability. 202.Pp 203The 204.Fn wcsnlen 205function conforms to 206.St -p1003.1-2008 . 207.Pp 208The 209.Fn wcslcat 210and 211.Fn wcslcpy 212functions conform to 213.St -p1003.1-2024 . 214.Pp 215The 216.Fn wmempcpy 217function is a 218.Nx 219extension. 220