man3p/wmemcpy.3p

   1 .\" Copyright (c) 2001-2003 The Open Group, All Rights Reserved
   2 .TH "WMEMCPY" P 2003 "IEEE/The Open Group" "POSIX Programmer's Manual"
   3 .\" wmemcpy
   4 .SH NAME
   5 wmemcpy \- copy wide characters in memory
   6 .SH SYNOPSIS
   7 .LP
   8 \fB#include <wchar.h>
   9 .br
  10 .sp
  11 wchar_t *wmemcpy(wchar_t *restrict\fP \fIws1\fP\fB, const wchar_t
  12 *restrict\fP \fIws2\fP\fB,
  13 .br
  14 \ \ \ \ \ \  size_t\fP \fIn\fP\fB);
  15 .br
  16 \fP
  17 .SH DESCRIPTION
  18 .LP
  19 The \fIwmemcpy\fP() function shall copy \fIn\fP wide characters from
  20 the object pointed to by \fIws2\fP to the object pointed
  21 to by \fIws1\fP. This function shall not be affected by locale and
  22 all \fBwchar_t\fP values shall be treated identically. The
  23 null wide character and \fBwchar_t\fP values not corresponding to
  24 valid characters shall not be treated specially.
  25 .LP
  26 If \fIn\fP is zero, the application shall ensure that \fIws1\fP and
  27 \fIws2\fP are valid pointers, and the function shall copy
  28 zero wide characters.
  29 .SH RETURN VALUE
  30 .LP
  31 The \fIwmemcpy\fP() function shall return the value of \fIws1\fP.
  32 .SH ERRORS
  33 .LP
  34 No errors are defined.
  35 .LP
  36 \fIThe following sections are informative.\fP
  37 .SH EXAMPLES
  38 .LP
  39 None.
  40 .SH APPLICATION USAGE
  41 .LP
  42 None.
  43 .SH RATIONALE
  44 .LP
  45 None.
  46 .SH FUTURE DIRECTIONS
  47 .LP
  48 None.
  49 .SH SEE ALSO
  50 .LP
  51 \fIwmemchr\fP() , \fIwmemcmp\fP() , \fIwmemmove\fP() , \fIwmemset\fP()
  52 , the Base Definitions volume of
  53 IEEE\ Std\ 1003.1-2001, \fI<wchar.h>\fP
  54 .SH COPYRIGHT
  55 Portions of this text are reprinted and reproduced in electronic form
  56 from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology
  57 -- Portable Operating System Interface (POSIX), The Open Group Base
  58 Specifications Issue 6, Copyright (C) 2001-2003 by the Institute of
  59 Electrical and Electronics Engineers, Inc and The Open Group. In the
  60 event of any discrepancy between this version and the original IEEE and
  61 The Open Group Standard, the original IEEE and The Open Group Standard
  62 is the referee document. The original Standard can be obtained online at
  63 http://www.opengroup.org/unix/online.html .