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 .\" 3. All advertising materials mentioning features or use of this software
  19 .\"    must display the following acknowledgement:
  20 .\"     This product includes software developed by the University of
  21 .\"     California, Berkeley and its contributors.
  22 .\" 4. Neither the name of the University nor the names of its contributors
  23 .\"    may be used to endorse or promote products derived from this software
  24 .\"    without specific prior written permission.
  25 .\"
  26 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  27 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  28 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  29 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  30 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  31 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  32 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  33 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  34 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  35 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  36 .\" SUCH DAMAGE.
  37 .\"
  38 .\"     from: @(#)strcpy.3      8.1 (Berkeley) 6/4/93
  39 .\"
  40 .\" $FreeBSD: src/lib/libc/string/wmemchr.3,v 1.6 2002/09/07 04:07:00 tjr Exp $
  41 .\"
  42 .Dd December 22, 2000
  43 .Dt WMEMCHR 3
  44 .Os
  45 .Sh NAME
  46 .Nm wmemchr ,
  47 .Nm wmemcmp ,
  48 .Nm wmemcpy ,
  49 .Nm wmemmove ,
  50 .Nm wmemset ,
  51 .Nm wcscat ,
  52 .Nm wcschr ,
  53 .Nm wcscmp ,
  54 .Nm wcscpy ,
  55 .Nm wcscspn ,
  56 .Nm wcslcat ,
  57 .Nm wcslcpy ,
  58 .Nm wcslen ,
  59 .Nm wcsncat ,
  60 .Nm wcsncmp ,
  61 .Nm wcsncpy ,
  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 wchar_t *
  82 .Fn wcscat "wchar_t * restrict s1" "const wchar_t * restrict s2"
  83 .Ft wchar_t *
  84 .Fn wcschr "const wchar_t *s" "wchar_t c"
  85 .Ft int
  86 .Fn wcscmp "const wchar_t *s1" "const wchar_t *s2"
  87 .Ft wchar_t *
  88 .Fn wcscpy "wchar_t * restrict s1" "const wchar_t * restrict s2"
  89 .Ft size_t
  90 .Fn wcscspn "const wchar_t *s1" "const wchar_t *s2"
  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 wchar_t *
  98 .Fn wcsncat "wchar_t * restrict s1" "const wchar_t * restrict s2" "size_t n"
  99 .Ft int
 100 .Fn wcsncmp "const wchar_t *s1" "const wchar_t * s2" "size_t n"
 101 .Ft wchar_t *
 102 .Fn wcsncpy "wchar_t * restrict s1" "const wchar_t * restrict s2" "size_t n"
 103 .Ft wchar_t *
 104 .Fn wcspbrk "const wchar_t *s1" "const wchar_t *s2"
 105 .Ft wchar_t *
 106 .Fn wcsrchr "const wchar_t *s" "wchar_t c"
 107 .Ft size_t
 108 .Fn wcsspn "const wchar_t *s1" "const wchar_t *s2"
 109 .Ft wchar_t *
 110 .Fn wcsstr "const wchar_t * restrict s1" "const wchar_t * restrict s2"
 111 .Sh DESCRIPTION
 112 The functions implement string manipulation operations over wide character
 113 strings.
 114 For a detailed description, refer to documents for the respective single-byte
 115 counterpart, such as
 116 .Xr memchr 3 .
 117 .Sh SEE ALSO
 118 .Xr memchr 3 ,
 119 .Xr memcmp 3 ,
 120 .Xr memcpy 3 ,
 121 .Xr memmove 3 ,
 122 .Xr memset 3 ,
 123 .Xr strcat 3 ,
 124 .Xr strchr 3 ,
 125 .Xr strcmp 3 ,
 126 .Xr strcpy 3 ,
 127 .Xr strcspn 3 ,
 128 .Xr strlcat 3 ,
 129 .Xr strlcpy 3 ,
 130 .Xr strlen 3 ,
 131 .Xr strncat 3 ,
 132 .Xr strncmp 3 ,
 133 .Xr strncpy 3 ,
 134 .Xr strpbrk 3 ,
 135 .Xr strrchr 3 ,
 136 .Xr strspn 3 ,
 137 .Xr strstr 3
 138 .Sh STANDARDS
 139 These functions conform to
 140 .St -isoC-99 ,
 141 with the exception of
 142 .Fn wcslcat
 143 and
 144 .Fn wcslcpy ,
 145 which are extensions.