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

   1 '\" te
   2 .\"  Copyright (c) 1992, X/Open Company Limited All Rights Reserved  Portions Copyright (c) 2002, Sun Microsystems, Inc.  All Rights Reserved
   3 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   4 .\" http://www.opengroup.org/bookstore/.
   5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   6 .\"  This notice shall appear on any product containing this material.
   7 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   9 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  10 .TH WMEMMOVE 3C "Aug 14, 2002"
  11 .SH NAME
  12 wmemmove \- copy wide-characters in memory with overlapping areas
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 #include <wchar.h>
  17
  18 \fBwchar_t *\fR\fBwmemmove\fR(\fBwchar_t *\fR\fIws1\fR, \fBconst wchar_t *\fR\fIws2\fR, \fBsize_t\fR \fIn\fR);
  19 .fi
  20
  21 .SH DESCRIPTION
  22 .sp
  23 .LP
  24 The \fBwmemmove()\fR function copies \fIn\fR wide-characters from the object
  25 pointed to by \fIws2\fR to the object pointed to by \fIws1\fR. Copying takes
  26 place as if the \fIn\fR wide-characters from the object pointed to by \fIws2\fR
  27 are first copied into a temporary array of \fIn\fR wide-characters that does
  28 not overlap the objects pointed to by \fIws1\fR or \fIws2\fR, and then the
  29 \fIn\fR wide-characters from the temporary array are copied into the object
  30 pointed to by \fIws1.\fR
  31 .sp
  32 .LP
  33 This function is not affected by locale and all \fBwchar_t\fR values are
  34 treated identically.  The null wide-character and \fBwchar_t\fR values not
  35 corresponding to valid  characters are not treated specially.
  36 .sp
  37 .LP
  38 If \fIn\fR is 0,  \fIws1\fR and \fIws2\fR must be a valid pointers, and the
  39 function copies zero wide-characters.
  40 .SH RETURN VALUES
  41 .sp
  42 .LP
  43 The \fBwmemmove()\fR function returns the value of \fIws1\fR.
  44 .SH ERRORS
  45 .sp
  46 .LP
  47 No errors are defined.
  48 .SH ATTRIBUTES
  49 .sp
  50 .LP
  51 See \fBattributes\fR(5) for descriptions of the following attributes:
  52 .sp
  53
  54 .sp
  55 .TS
  56 box;
  57 c | c
  58 l | l .
  59 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  60 _
  61 Interface Stability     Standard
  62 _
  63 MT-Level        MT-Safe
  64 .TE
  65
  66 .SH SEE ALSO
  67 .sp
  68 .LP
  69 \fBwmemchr\fR(3C), \fBwmemcmp\fR(3C), \fBwmemcpy\fR(3C), \fBwmemset\fR(3C),
  70 \fBattributes\fR(5), \fBstandards\fR(5)