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