xref: /illumos-gate/usr/src/man/man3c/btowc.3c (revision e3ae4b35c024af1196582063ecee3ab79367227d)

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
http://www.opengroup.org/bookstore/.

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 SunOS 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.

This notice shall appear on any product containing this material.

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.

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.

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]


Copyright (c) 1992, X/Open Company Limited. All Rights Reserved.
Portions Copyright (c) 2002, Sun Microsystems, Inc. All Rights Reserved
Copyright (c) 2014, Joyent, Inc. All rights reserved.

BTOWC 3C "Jun 27, 2014"
NAME
btowc, btowc_l - single-byte to wide-character conversion
SYNOPSIS

#include <stdio.h>
#include <wchar.h>

wint_t btowc(int c);

#include <stdio.h>
#include <wchar.h>
#include <xlocale.h>

wint_t btowc_l(int c, locale_t loc);
DESCRIPTION

The btowc() and btowc_l()functions determines whether c constitutes a valid (one-byte) character in the initial shift state.

The behavior of btowc() is affected by the LC_CTYPE category of the current locale. See environ(7). The function btowc_l() does not use the current locale, and instead operates on the locale specified by loc.

RETURN VALUES

The btowc() function returns WEOF if c has the value EOF or if (unsigned char)c does not constitute a valid (one-byte) character in the initial shift state. Otherwise, it returns the wide-character representation of that character.

ERRORS

No errors are defined.

ATTRIBUTES

See attributes(7) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability See below.
MT-Level MT-Safe

The btowc() function is Standard. The btowc_l() function is Uncommitted.

SEE ALSO

newlocale (3C), setlocale (3C), uselocale (3C), wctob (3C), attributes (7), environ (7), standards (7)