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 WCTOB 3C "Aug 14, 2002"
  11 .SH NAME
  12 wctob, wctob_l \- wide-character to single-byte conversion
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 #include <stdio.h>
  17 #include <wchar.h>
  18 
  19 \fBint\fR \fBwctob\fR(\fBwint_t\fR \fIc\fR);
  20 \fBint\fR \fBwctob_l\fR(\fBwint_t\fR \fIc\fR, \fBlocale_t\fR \fIloc\fR);
  21 .fi
  22 
  23 .SH DESCRIPTION
  24 .sp
  25 .LP
  26 The \fBwctob()\fR function determines whether \fIc\fR corresponds to a member
  27 of the extended character set whose  character representation is a single byte
  28 when in the initial shift state.
  29 .sp
  30 .LP
  31 The behavior of this function is affected by the \fBLC_CTYPE\fR category of the
  32 current locale.  See \fBenviron\fR(5)
  33 .sp
  34 .LP
  35 The function \fBwctob_l()\fR behaves identically to \fBwctob()\fR, except
  36 instead of operating in the current environemtn, it operates in the environment
  37 specified by \fIloc\fR.
  38 .SH RETURN VALUES
  39 .sp
  40 .LP
  41 The \fBwctob()\fR function returns \fBEOF\fR if \fIc\fR does not correspond to
  42 a character with length one in the initial shift state.  Otherwise, it returns
  43 the single-byte representation of that character.
  44 .SH ERRORS
  45 .sp
  46 .LP
  47 No errors are defined.
  48 .SH ATTRIBUTES
  49 .sp
  50 .LP
  51 See \fBattributes\fR(5) for descriptions of the following attributes:
  52 .sp
  53 
  54 .sp
  55 .TS
  56 box;
  57 c | c
  58 l | l .
  59 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  60 _
  61 Interface Stability     Standard
  62 _
  63 MT-Level        MT-Safe with exceptions
  64 .TE
  65 
  66 .SH SEE ALSO
  67 .sp
  68 .LP
  69 \fBbtowc\fR(3C), \fBsetlocale\fR(3C), \fBattributes\fR(5), \fBenviron\fR(5),
  70 \fBstandards\fR(5)
  71 .SH NOTES
  72 .sp
  73 .LP
  74 The \fBwctob()\fR function can be used safely in multithreaded applications, as
  75 long as \fBsetlocale\fR(3C) is not being called to change the locale.