usr/src/man/man3c/wmemchr.3c

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright (c) 1992, X/Open Company Limited.  All Rights Reserved.
  44 .\" Portions Copyright (c) 2002, Sun Microsystems, Inc.  All Rights Reserved
  45 .\"
  46 .TH WMEMCHR 3C "Aug 14, 2002"
  47 .SH NAME
  48 wmemchr \- find a wide-character in memory
  49 .SH SYNOPSIS
  50 .LP
  51 .nf
  52 #include <wchar.h>
  53
  54 \fBwchar_t *\fR\fBwmemchr\fR(\fBconst wchar_t *\fR\fIws\fR, \fBwchar_t\fR \fIwc\fR, \fBsize_t\fR \fIn\fR);
  55 .fi
  56
  57 .SS "ISO C++"
  58 .LP
  59 .nf
  60 #include <wchar.h>
  61
  62 \fBconst wchar_t *\fR\fBwmemchr\fR(\fBconst wchar_t *\fR\fIws\fR, \fBwchar_t\fR \fIwc\fR, \fBsize_t\fR \fIn\fR);
  63 .fi
  64
  65 .LP
  66 .nf
  67 #include <cwchar>
  68
  69 \fBwchar_t *std::\fR\fBwmemchr\fR(\fBwchar_t *\fR\fIws\fR, \fBwchar_t\fR \fIwc\fR, \fBsize_t\fR \fIn\fR);
  70 .fi
  71
  72 .SH DESCRIPTION
  73 .sp
  74 .LP
  75 The \fBwmemchr()\fR function locates the first occurrence of \fIwc\fR in the
  76 initial \fIn\fR wide-characters of the object pointed to be \fIws\fR. This
  77 function is not affected by locale and all \fBwchar_t\fR values are treated
  78 identically.  The null wide-character and \fBwchar_t\fR values not
  79 corresponding to valid  characters are not treated specially.
  80 .sp
  81 .LP
  82 If \fIn\fR is 0,  \fIws\fR must be a valid pointer and the function behaves as
  83 if no valid occurrence of \fIwc\fR is found.
  84 .SH RETURN VALUES
  85 .sp
  86 .LP
  87 The \fBwmemchr()\fR function returns a pointer to the located  wide-character,
  88 or a null pointer if the wide-character does not occur in the object.
  89 .SH ERRORS
  90 .sp
  91 .LP
  92 No errors are defined.
  93 .SH ATTRIBUTES
  94 .sp
  95 .LP
  96 See \fBattributes\fR(5) for descriptions of the following attributes:
  97 .sp
  98
  99 .sp
 100 .TS
 101 box;
 102 c | c
 103 l | l .
 104 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 105 _
 106 Interface Stability     Standard
 107 _
 108 MT-Level        MT-Safe
 109 .TE
 110
 111 .SH SEE ALSO
 112 .sp
 113 .LP
 114 \fBwmemcmp\fR(3C), \fBwmemcpy\fR(3C), \fBwmemmove\fR(3C), \fBwmemset\fR(3C),
 115 \fBattributes\fR(5), \fBstandards\fR(5)