[thirdparty/man-pages.git] / man3 / wctob.3

.\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
.\"
.\" %%%LICENSE_START(GPLv2+_DOC_ONEPARA)
.\" This is free documentation; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License as
.\" published by the Free Software Foundation; either version 2 of
.\" the License, or (at your option) any later version.
.\" %%%LICENSE_END
.\"
.\" References consulted:
.\"   GNU glibc-2 source code and manual
.\"   Dinkumware C library reference http://www.dinkumware.com/
.\"   OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
.\"   ISO/IEC 9899:1999
.\"
.TH WCTOB 3 2017-09-15 "GNU" "Linux Programmer's Manual"
.SH NAME
wctob \- try to represent a wide character as a single byte
.SH SYNOPSIS
.nf
.B #include <wchar.h>
.PP
.BI "int wctob(wint_t " c );
.fi
.SH DESCRIPTION
The
.BR wctob ()
function tests whether
the multibyte representation of the
wide character
.IR c ,
starting in the initial state, consists of a single
byte.
If so, it is returned as an
.IR "unsigned char" .
.PP
Never use this function.
It cannot help you in writing internationalized
programs.
Internationalized programs must never distinguish single-byte and
multibyte characters.
.SH RETURN VALUE
The
.BR wctob ()
function returns the single-byte representation of
.IR c ,
if it exists, of
.B EOF
otherwise.
.SH ATTRIBUTES
For an explanation of the terms used in this section, see
.BR attributes (7).
.TS
allbox;
lb lb lb
l l l.
Interface	Attribute	Value
T{
.BR wctob ()
T}	Thread safety	MT-Safe
.TE
.sp 1
.SH CONFORMING TO
POSIX.1-2001, POSIX.1-2008, C99.
.SH NOTES
The behavior of
.BR wctob ()
depends on the
.B LC_CTYPE
category of the
current locale.
.PP
This function should never be used.
Internationalized programs must never
distinguish single-byte and multibyte characters.
Use either
.BR wctomb (3)
or the thread-safe
.BR wcrtomb (3)
instead.
.SH SEE ALSO
.BR btowc (3),
.BR wcrtomb (3),
.BR wctomb (3)
Commit	Line	Data
	1	.\" Copyright (c) Bruno Haible <haible@clisp.cons.org>
	2	.\"
	3	.\" %%%LICENSE_START(GPLv2+_DOC_ONEPARA)
	4	.\" This is free documentation; you can redistribute it and/or
	5	.\" modify it under the terms of the GNU General Public License as
	6	.\" published by the Free Software Foundation; either version 2 of
	7	.\" the License, or (at your option) any later version.
	8	.\" %%%LICENSE_END
	9	.\"
	10	.\" References consulted:
	11	.\" GNU glibc-2 source code and manual
	12	.\" Dinkumware C library reference http://www.dinkumware.com/
	13	.\" OpenGroup's Single UNIX specification http://www.UNIX-systems.org/online.html
	14	.\" ISO/IEC 9899:1999
	15	.\"
	16	.TH WCTOB 3 2017-09-15 "GNU" "Linux Programmer's Manual"
	17	.SH NAME
	18	wctob \- try to represent a wide character as a single byte
	19	.SH SYNOPSIS
	20	.nf
	21	.B #include <wchar.h>
	22	.PP
	23	.BI "int wctob(wint_t " c );
	24	.fi
	25	.SH DESCRIPTION
	26	The
	27	.BR wctob ()
	28	function tests whether
	29	the multibyte representation of the
	30	wide character
	31	.IR c ,
	32	starting in the initial state, consists of a single
	33	byte.
	34	If so, it is returned as an
	35	.IR "unsigned char" .
	36	.PP
	37	Never use this function.
	38	It cannot help you in writing internationalized
	39	programs.
	40	Internationalized programs must never distinguish single-byte and
	41	multibyte characters.
	42	.SH RETURN VALUE
	43	The
	44	.BR wctob ()
	45	function returns the single-byte representation of
	46	.IR c ,
	47	if it exists, of
	48	.B EOF
	49	otherwise.
	50	.SH ATTRIBUTES
	51	For an explanation of the terms used in this section, see
	52	.BR attributes (7).
	53	.TS
	54	allbox;
	55	lb lb lb
	56	l l l.
	57	Interface Attribute Value
	58	T{
	59	.BR wctob ()
	60	T} Thread safety MT-Safe
	61	.TE
	62	.sp 1
	63	.SH CONFORMING TO
	64	POSIX.1-2001, POSIX.1-2008, C99.
	65	.SH NOTES
	66	The behavior of
	67	.BR wctob ()
	68	depends on the
	69	.B LC_CTYPE
	70	category of the
	71	current locale.
	72	.PP
	73	This function should never be used.
	74	Internationalized programs must never
	75	distinguish single-byte and multibyte characters.
	76	Use either
	77	.BR wctomb (3)
	78	or the thread-safe
	79	.BR wcrtomb (3)
	80	instead.
	81	.SH SEE ALSO
	82	.BR btowc (3),
	83	.BR wcrtomb (3),
	84	.BR wctomb (3)