usr/src/man/man3c/wmemmove.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 WMEMMOVE 3C "Aug 14, 2002"
  47 .SH NAME
  48 wmemmove \- copy wide-characters in memory with overlapping areas
  49 .SH SYNOPSIS
  50 .LP
  51 .nf
  52 #include <wchar.h>
  53
  54 \fBwchar_t *\fR\fBwmemmove\fR(\fBwchar_t *\fR\fIws1\fR, \fBconst wchar_t *\fR\fIws2\fR, \fBsize_t\fR \fIn\fR);
  55 .fi
  56
  57 .SH DESCRIPTION
  58 .sp
  59 .LP
  60 The \fBwmemmove()\fR function copies \fIn\fR wide-characters from the object
  61 pointed to by \fIws2\fR to the object pointed to by \fIws1\fR. Copying takes
  62 place as if the \fIn\fR wide-characters from the object pointed to by \fIws2\fR
  63 are first copied into a temporary array of \fIn\fR wide-characters that does
  64 not overlap the objects pointed to by \fIws1\fR or \fIws2\fR, and then the
  65 \fIn\fR wide-characters from the temporary array are copied into the object
  66 pointed to by \fIws1.\fR
  67 .sp
  68 .LP
  69 This function is not affected by locale and all \fBwchar_t\fR values are
  70 treated identically.  The null wide-character and \fBwchar_t\fR values not
  71 corresponding to valid  characters are not treated specially.
  72 .sp
  73 .LP
  74 If \fIn\fR is 0,  \fIws1\fR and \fIws2\fR must be a valid pointers, and the
  75 function copies zero wide-characters.
  76 .SH RETURN VALUES
  77 .sp
  78 .LP
  79 The \fBwmemmove()\fR function returns the value of \fIws1\fR.
  80 .SH ERRORS
  81 .sp
  82 .LP
  83 No errors are defined.
  84 .SH ATTRIBUTES
  85 .sp
  86 .LP
  87 See \fBattributes\fR(5) for descriptions of the following attributes:
  88 .sp
  89
  90 .sp
  91 .TS
  92 box;
  93 c | c
  94 l | l .
  95 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  96 _
  97 Interface Stability     Standard
  98 _
  99 MT-Level        MT-Safe
 100 .TE
 101
 102 .SH SEE ALSO
 103 .sp
 104 .LP
 105 \fBwmemchr\fR(3C), \fBwmemcmp\fR(3C), \fBwmemcpy\fR(3C), \fBwmemset\fR(3C),
 106 \fBattributes\fR(5), \fBstandards\fR(5)