usr/src/man/man3c/wctomb.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 .\" Copyright 2014 Garrett D'Amore <garrett@damore.org>
  46 .\"
  47 .TH WCTOMB 3C "Jun 25, 2014"
  48 .SH NAME
  49 wctomb, wctomb_l \- convert a wide-character code to a character
  50 .SH SYNOPSIS
  51 .LP
  52 .nf
  53 #include <stdlib.h>
  54
  55 \fBint\fR \fBwctomb\fR(\fBchar *\fR\fIs\fR, \fBwchar_t\fR \fIwchar\fR);
  56 .fi
  57 .LP
  58 .nf
  59 #include <stdlib.h>
  60 #include <xlocale.h>
  61
  62 \fBint\fR \fBwctomb_l\fR(\fBchar *\fR\fIs\fR, \fBwchar_t\fR \fIwchar\fR, \fBlocale_t\fR \fIloc\fR);
  63 .fi
  64 .SH DESCRIPTION
  65 .LP
  66 The \fBwctomb()\fR function determines the number of bytes needed to represent
  67 the character corresponding to the wide-character code whose value is
  68 \fIwchar\fR. It stores the character representation (possibly multiple bytes)
  69 in the array object pointed to by \fIs\fR (if \fIs\fR is not a null pointer).
  70 At most \fBMB_CUR_MAX\fR bytes are stored.
  71 .LP
  72 A call with \fIs\fR as a null pointer causes this function to return \fB0\fR.
  73 The behavior of this function is affected by the \fBLC_CTYPE\fR category of the
  74 current locale.
  75 .LP
  76 The function \fBwctomb_l()\fR behaves identically to \fBwctomb()\fR, except
  77 instead of operating in the current locale, it operates in the locale
  78 specified by \fIloc\fR.
  79 .SH RETURN VALUES
  80 .LP
  81 If \fIs\fR is a null pointer, \fBwctomb()\fR returns \fB0\fR value. If \fIs\fR
  82 is not a null pointer, \fBwctomb()\fR returns \fB\(mi1\fR if the value of
  83 \fIwchar\fR does not correspond to a valid character, or returns the number of
  84 bytes that constitute the character corresponding to the value of \fIwchar\fR.
  85 .LP
  86 In no case will the value returned be greater than the value of the
  87 \fBMB_CUR_MAX\fR macro.
  88 .SH ERRORS
  89 .LP
  90 No errors are defined.
  91 .SH ATTRIBUTES
  92 .LP
  93 See \fBattributes\fR(5) for descriptions of the following attributes:
  94 .TS
  95 box;
  96 c | c
  97 l | l .
  98 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  99 _
 100 CSI     Enabled
 101 _
 102 Interface Stability     See below.
 103 _
 104 MT-Level        MT-Safe
 105 .TE
 106
 107 .LP
 108 The \fBwctomb()\fR function is Standard.  The \fBwctomb_l()\fR function
 109 is Uncommitted.
 110 .SH SEE ALSO
 111 .LP
 112 \fBmblen\fR(3C), \fBmbstowcs\fR(3C), \fBmbtowc\fR(3C),
 113 \fBnewlocale\fR(3C), \fBsetlocale\fR(3C), \fBuselocale\fR(3C),
 114 \fBwcstombs\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5)