usr/src/man/man3c/wmemcmp.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 WMEMCMP 3C "Aug 14, 2002"
  11 .SH NAME
  12 wmemcmp \- compare wide-characters in memory
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 #include <wchar.h>
  17
  18 \fBint\fR \fBwmemcmp\fR(\fBconst wchar_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 \fBwmemcmp()\fR function compares the first \fIn\fR wide-characters of the
  25 object pointed to by \fIws1\fR to the first \fIn\fR wide-characters of the
  26 object pointed to by \fIws2\fR. This function is not affected by locale and all
  27 \fBwchar_t\fR values are treated identically.  The null  wide-character and
  28 \fBwchar_t\fR values not corresponding to valid  characters are not treated
  29 specially.
  30 .sp
  31 .LP
  32 If \fIn\fR is zero,  \fIws1\fR and \fIws2\fR must be a valid pointers and the
  33 function behaves as if the two objects compare equal.
  34 .SH RETURN VALUES
  35 .sp
  36 .LP
  37 The \fBwmemcmp()\fR function returns an integer greater than, equal to, or less
  38 than 0, accordingly as the object pointed to by \fIws1\fR is greater than,
  39 equal to, or less than the object pointed to by \fIws2\fR.
  40 .SH ERRORS
  41 .sp
  42 .LP
  43 No errors are defined.
  44 .SH ATTRIBUTES
  45 .sp
  46 .LP
  47 See \fBattributes\fR(5) for descriptions of the following attributes:
  48 .sp
  49
  50 .sp
  51 .TS
  52 box;
  53 c | c
  54 l | l .
  55 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  56 _
  57 Interface Stability     Standard
  58 _
  59 MT-Level        MT-Safe
  60 .TE
  61
  62 .SH SEE ALSO
  63 .sp
  64 .LP
  65 \fBwmemchr\fR(3C), \fBwmemcpy\fR(3C), \fBwmemmove\fR(3C), \fBwmemset\fR(3C),
  66 \fBattributes\fR(5), \fBstandards\fR(5)