usr/src/man/man3c/wctob.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 WCTOB 3C "Jun 25, 2014"
  48 .SH NAME
  49 wctob, wctob_l \- wide-character to single-byte conversion
  50 .SH SYNOPSIS
  51 .LP
  52 .nf
  53 #include <stdio.h>
  54 #include <wchar.h>
  55
  56 \fBint\fR \fBwctob\fR(\fBwint_t\fR \fIc\fR);
  57 .fi
  58 .LP
  59 .nf
  60 #include <stdio.h>
  61 #include <wchar.h>
  62 #include <xlocale.h>
  63
  64 \fBint\fR \fBwctob_l\fR(\fBwint_t\fR \fIc\fR, \fBlocale_t\fR \fIloc\fR);
  65 .fi
  66 .SH DESCRIPTION
  67 .LP
  68 The \fBwctob()\fR function determines whether \fIc\fR corresponds to a member
  69 of the extended character set whose  character representation is a single byte
  70 when in the initial shift state.
  71 .LP
  72 The behavior of \fBwctob()\fR is affected by the \fBLC_CTYPE\fR category of the
  73 current locale.  See \fBenviron\fR(5)
  74 .LP
  75 The function \fBwctob_l()\fR behaves identically to \fBwctob()\fR, except
  76 instead of operating in the current locale, it operates in the locale
  77 specified by \fIloc\fR.
  78 .SH RETURN VALUES
  79 .LP
  80 These functions return \fBEOF\fR if \fIc\fR does not correspond to
  81 a character with length one in the initial shift state.  Otherwise, they return
  82 the single-byte representation of that character.
  83 .SH ERRORS
  84 .LP
  85 No errors are defined.
  86 .SH ATTRIBUTES
  87 .LP
  88 See \fBattributes\fR(5) for descriptions of the following attributes:
  89 .TS
  90 box;
  91 c | c
  92 l | l .
  93 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  94 _
  95 Interface Stability     See below
  96 _
  97 MT-Level        MT-Safe
  98 .TE
  99
 100 .LP
 101 The \fBwctob()\fR function is Standard.  The \fBwctob_l()\fR function
 102 is Uncommitted.
 103 .SH SEE ALSO
 104 .LP
 105 \fBbtowc\fR(3C), \fBnewlocale\fR(3C), \fBsetlocale\fR(3C), \fBuselocale\fR(3C),
 106 \fBattributes\fR(5), \fBenviron\fR(5), \fBstandards\fR(5)