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 WCTOMB 3C "Aug 14, 2002"
  11 .SH NAME
  12 wctomb, wctomb_l \- convert a wide-character code to a character
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 #include <stdlib.h>
  17 
  18 \fBint\fR \fBwctomb\fR(\fBchar *\fR\fIs\fR, \fBwchar_t\fR \fIwchar\fR);
  19 \fBint\fR \fBwctomb_l\fR(\fBchar *\fR\fIs\fR, \fBwchar_t\fR \fIwchar\fR, \fBlocale_t\fR \fIloc\fR);
  20 .fi
  21 
  22 .SH DESCRIPTION
  23 .sp
  24 .LP
  25 The \fBwctomb()\fR function determines the number of bytes needed to represent
  26 the character corresponding to the wide-character code whose value is
  27 \fIwchar\fR. It stores the character representation (possibly multiple bytes)
  28 in the array object pointed to by \fIs\fR (if \fIs\fR is not a null pointer).
  29 At most \fBMB_CUR_MAX\fR bytes are stored.
  30 .sp
  31 .LP
  32 A call with \fIs\fR as a null pointer causes this function to return \fB0\fR.
  33 The behavior of this function is affected by the \fBLC_CTYPE\fR category of the
  34 current locale.
  35 .sp
  36 .LP
  37 The function \fBwctomb_l()\fR behaves identically to \fBwctomb()\fR, except
  38 instead of operating in the current environemtn, it operates in the environment
  39 specified by \fIloc\fR.
  40 .SH RETURN VALUES
  41 .sp
  42 .LP
  43 If \fIs\fR is a null pointer, \fBwctomb()\fR returns \fB0\fR value. If \fIs\fR
  44 is not a null pointer, \fBwctomb()\fR returns \fB\(mi1\fR if the value of
  45 \fIwchar\fR does not correspond to a valid character, or returns the number of
  46 bytes that constitute the character corresponding to the value of \fIwchar\fR.
  47 .sp
  48 .LP
  49 In no case will the value returned be greater than the value of the
  50 \fBMB_CUR_MAX\fR macro.
  51 .SH ERRORS
  52 .sp
  53 .LP
  54 No errors are defined.
  55 .SH USAGE
  56 .sp
  57 .LP
  58 The \fBwctomb()\fR function can be used safely in a multithreaded application,
  59 as long as \fBsetlocale\fR(3C) is not being called to change the locale.
  60 .SH ATTRIBUTES
  61 .sp
  62 .LP
  63 See \fBattributes\fR(5) for descriptions of the following attributes:
  64 .sp
  65 
  66 .sp
  67 .TS
  68 box;
  69 c | c
  70 l | l .
  71 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  72 _
  73 CSI     Enabled
  74 _
  75 Interface Stability     Standard
  76 _
  77 MT-Level        MT-Safe with exceptions
  78 .TE
  79 
  80 .SH SEE ALSO
  81 .sp
  82 .LP
  83 \fBmblen\fR(3C), \fBmbstowcs\fR(3C), \fBmbtowc\fR(3C), \fBsetlocale\fR(3C),
  84 \fBwcstombs\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)