string/FreeBSD/wmemchr.3

   1 .\"     $NetBSD: wmemchr.3,v 1.4 2001/01/02 11:26:23 itojun 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 .\" 4. 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 .\" $FreeBSD: src/lib/libc/string/wmemchr.3,v 1.10 2009/03/04 06:01:27 das Exp $
  37 .\"
  38 .Dd March 4, 2009
  39 .Dt WMEMCHR 3
  40 .Os
  41 .Sh NAME
  42 .Nm wcpcpy ,
  43 .Nm wcpncpy ,
  44 .Nm wcscasecmp ,
  45 .Nm wcscat ,
  46 .Nm wcschr ,
  47 .Nm wcscmp ,
  48 .Nm wcscpy ,
  49 .Nm wcscspn ,
  50 .Nm wcsdup ,
  51 .Nm wcslcat ,
  52 .Nm wcslcpy ,
  53 .Nm wcslen ,
  54 .Nm wcsncasecmp ,
  55 .Nm wcsncat ,
  56 .Nm wcsncmp ,
  57 .Nm wcsncpy ,
  58 .Nm wcsnlen ,
  59 .Nm wcspbrk ,
  60 .Nm wcsrchr ,
  61 .Nm wcsspn ,
  62 .Nm wcsstr ,
  63 .Nm wmemchr ,
  64 .Nm wmemcmp ,
  65 .Nm wmemcpy ,
  66 .Nm wmemmove ,
  67 .Nm wmemset
  68 .Nd wide character string manipulation operations
  69 .Sh LIBRARY
  70 .Lb libc
  71 .Sh SYNOPSIS
  72 .In wchar.h
  73 .Ft wchar_t *
  74 .Fn wcpcpy "wchar_t *s1" "wchar_t *s2"
  75 .Ft wchar_t *
  76 .Fn wcpncpy "wchar_t *s1" "wchar_t *s2" "size_t n"
  77 .Ft int
  78 .Fn wcscasecmp "const wchar_t *s1" "const wchar_t *s2"
  79 .Ft wchar_t *
  80 .Fn wcscat "wchar_t * restrict s1" "const wchar_t * restrict s2"
  81 .Ft wchar_t *
  82 .Fn wcschr "const wchar_t *s" "wchar_t c"
  83 .Ft int
  84 .Fn wcscmp "const wchar_t *s1" "const wchar_t *s2"
  85 .Ft wchar_t *
  86 .Fn wcscpy "wchar_t * restrict s1" "const wchar_t * restrict s2"
  87 .Ft size_t
  88 .Fn wcscspn "const wchar_t *s1" "const wchar_t *s2"
  89 .Ft wchar_t *
  90 .Fn wcsdup "const wchar_t *s"
  91 .Ft size_t
  92 .Fn wcslcat "wchar_t *s1" "const wchar_t *s2" "size_t n"
  93 .Ft size_t
  94 .Fn wcslcpy "wchar_t *s1" "const wchar_t *s2" "size_t n"
  95 .Ft size_t
  96 .Fn wcslen "const wchar_t *s"
  97 .Ft int
  98 .Fn wcsncasecmp "const wchar_t *s1" "const wchar_t *s2" "size_t n"
  99 .Ft wchar_t *
 100 .Fn wcsncat "wchar_t * restrict s1" "const wchar_t * restrict s2" "size_t n"
 101 .Ft int
 102 .Fn wcsncmp "const wchar_t *s1" "const wchar_t * s2" "size_t n"
 103 .Ft wchar_t *
 104 .Fn wcsncpy "wchar_t * restrict s1" "const wchar_t * restrict s2" "size_t n"
 105 .Ft size_t
 106 .Fn wcsnlen "const wchar_t *s" "size_t maxlen"
 107 .Ft wchar_t *
 108 .Fn wcspbrk "const wchar_t *s1" "const wchar_t *s2"
 109 .Ft wchar_t *
 110 .Fn wcsrchr "const wchar_t *s" "wchar_t c"
 111 .Ft size_t
 112 .Fn wcsspn "const wchar_t *s1" "const wchar_t *s2"
 113 .Ft wchar_t *
 114 .Fn wcsstr "const wchar_t * restrict s1" "const wchar_t * restrict s2"
 115 .Ft wchar_t *
 116 .Fn wmemchr "const wchar_t *s" "wchar_t c" "size_t n"
 117 .Ft int
 118 .Fn wmemcmp "const wchar_t *s1" "const wchar_t *s2" "size_t n"
 119 .Ft wchar_t *
 120 .Fn wmemcpy "wchar_t * restrict s1" "const wchar_t * restrict s2" "size_t n"
 121 .Ft wchar_t *
 122 .Fn wmemmove "wchar_t *s1" "const wchar_t *s2" "size_t n"
 123 .Ft wchar_t *
 124 .Fn wmemset "wchar_t *s" "wchar_t c" "size_t n"
 125 .In wchar.h
 126 .In xlocale.h
 127 .Ft int
 128 .Fn wcscasecmp_l "const wchar_t *s1" "const wchar_t *s2" "locale_t loc"
 129 .Ft int
 130 .Fn wcsncasecmp_l "const wchar_t *s1" "const wchar_t *s2" "size_t n" "locale_t loc"
 131 .Sh DESCRIPTION
 132 The functions implement string manipulation operations over wide character
 133 strings.
 134 For a detailed description, refer to documents for the respective single-byte
 135 counterpart, such as
 136 .Xr memchr 3 .
 137 .Sh SEE ALSO
 138 .Xr memchr 3 ,
 139 .Xr memcmp 3 ,
 140 .Xr memcpy 3 ,
 141 .Xr memmove 3 ,
 142 .Xr memset 3 ,
 143 .Xr stpcpy 3 ,
 144 .Xr stpncpy 3 ,
 145 .Xr strcasecmp 3 ,
 146 .Xr strcasecmp_l 3 ,
 147 .Xr strcat 3 ,
 148 .Xr strchr 3 ,
 149 .Xr strcmp 3 ,
 150 .Xr strcpy 3 ,
 151 .Xr strcspn 3 ,
 152 .Xr strdup 3 ,
 153 .Xr strlcat 3 ,
 154 .Xr strlcpy 3 ,
 155 .Xr strlen 3 ,
 156 .Xr strncasecmp 3 ,
 157 .Xr strncasecmp_l 3 ,
 158 .Xr strncat 3 ,
 159 .Xr strncmp 3 ,
 160 .Xr strncpy 3 ,
 161 .Xr strnlen 3 ,
 162 .Xr strpbrk 3 ,
 163 .Xr strrchr 3 ,
 164 .Xr strspn 3 ,
 165 .Xr strstr 3 ,
 166 .Xr xlocale 3
 167 .Sh STANDARDS
 168 These functions conform to
 169 .St -isoC-99 ,
 170 with the exception of
 171 .Fn wcpcpy ,
 172 .Fn wcpncpy ,
 173 .Fn wcscasecmp ,
 174 .Fn wcscasecmp_l ,
 175 .Fn wcsdup ,
 176 .Fn wcsncasecmp ,
 177 .Fn wcsncasecmp_l ,
 178 and
 179 .Fn wcsnlen ,
 180 which conform to
 181 .St -p1003.1-2008 ;
 182 and
 183 .Fn wcslcat
 184 and
 185 .Fn wcslcpy ,
 186 which are extensions.