lib/libc/string/wmemchr.3

   1 .\"     $NetBSD: wmemchr.3,v 1.15 2010/12/16 17:42:28 wiz 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 May 1, 2009
  37 .Dt WMEMCHR 3
  38 .Os
  39 .Sh NAME
  40 .Nm wmemchr ,
  41 .Nm wmemcmp ,
  42 .Nm wmemcpy ,
  43 .Nm wmemmove ,
  44 .Nm wmemset ,
  45 .Nm wcscat ,
  46 .Nm wcschr ,
  47 .Nm wcscmp ,
  48 .Nm wcscpy ,
  49 .Nm wcscspn ,
  50 .Nm wcslcat ,
  51 .Nm wcslcpy ,
  52 .Nm wcslen ,
  53 .Nm wcsncat ,
  54 .Nm wcsncmp ,
  55 .Nm wcsncpy ,
  56 .Nm wcspbrk ,
  57 .Nm wcsrchr ,
  58 .Nm wcsspn ,
  59 .Nm wcsstr
  60 .Nm wcswcs
  61 .Nd wide-character string manipulation operations
  62 .Sh LIBRARY
  63 .Lb libc
  64 .Sh SYNOPSIS
  65 .In wchar.h
  66 .Ft wchar_t *
  67 .Fn wmemchr "const wchar_t *s" "wchar_t c" "size_t n"
  68 .Ft int
  69 .Fn wmemcmp "const wchar_t *s1" "const wchar_t *s2" "size_t n"
  70 .Ft wchar_t *
  71 .Fn wmemcpy "wchar_t * restrict s1" "const wchar_t * restrict s2" "size_t n"
  72 .Ft wchar_t *
  73 .Fn wmemmove "wchar_t *s1" "const wchar_t *s2" "size_t n"
  74 .Ft wchar_t *
  75 .Fn wmemset "wchar_t *s" "wchar_t c" "size_t n"
  76 .Ft wchar_t *
  77 .Fn wcscat "wchar_t * restrict s1" "const wchar_t * restrict s2"
  78 .Ft wchar_t *
  79 .Fn wcschr "const wchar_t *s" "wchar_t c"
  80 .Ft int
  81 .Fn wcscmp "const wchar_t *s1" "const wchar_t *s2"
  82 .Ft wchar_t *
  83 .Fn wcscpy "wchar_t * restrict s1" "const wchar_t * restrict s2"
  84 .Ft size_t
  85 .Fn wcscspn "const wchar_t *s1" "const wchar_t *s2"
  86 .Ft size_t
  87 .Fn wcslcat "wchar_t *s1" "const wchar_t *s2" "size_t n"
  88 .Ft size_t
  89 .Fn wcslcpy "wchar_t *s1" "const wchar_t *s2" "size_t n"
  90 .Ft size_t
  91 .Fn wcslen "const wchar_t *s"
  92 .Ft wchar_t *
  93 .Fn wcsncat "wchar_t * restrict s1" "const wchar_t * restrict s2" "size_t n"
  94 .Ft int
  95 .Fn wcsncmp "const wchar_t *s1" "const wchar_t * s2" "size_t n"
  96 .Ft wchar_t *
  97 .Fn wcsncpy "wchar_t * restrict s1" "const wchar_t * restrict s2" "size_t n"
  98 .Ft wchar_t *
  99 .Fn wcspbrk "const wchar_t *s1" "const wchar_t *s2"
 100 .Ft wchar_t *
 101 .Fn wcsrchr "const wchar_t *s" "wchar_t c"
 102 .Ft size_t
 103 .Fn wcsspn "const wchar_t *s1" "const wchar_t *s2"
 104 .Ft wchar_t *
 105 .Fn wcsstr "const wchar_t *s1" "const wchar_t *s2"
 106 .Ft wchar_t *
 107 .Fn wcswcs "const wchar_t *s1" "const wchar_t *s2"
 108 .Sh DESCRIPTION
 109 These functions implement string manipulation operations over wide-character
 110 strings.
 111 For a detailed description, refer to the documents for the respective
 112 single-byte counterpart, such as
 113 .Xr memchr 3 .
 114 The
 115 .Fn wcswcs
 116 function is not a part of
 117 .St -isoC
 118 and
 119 .St -isoC-amd1 ,
 120 the
 121 .Fn wcsstr
 122 function is strongly recommended to be used.
 123 .Sh SEE ALSO
 124 .Xr memchr 3 ,
 125 .Xr memcmp 3 ,
 126 .Xr memcpy 3 ,
 127 .Xr memmove 3 ,
 128 .Xr memset 3 ,
 129 .Xr stpcpy 3 ,
 130 .Xr stpncpy 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 and were first introduced in
 153 .St -isoC-amd1 ,
 154 with the exception of
 155 .Fn wcslcat
 156 and
 157 .Fn wcslcpy ,
 158 which are extensions.
 159 The
 160 .Fn wcswcs
 161 function conforms to
 162 .St -xpg4.2 .