WCTRANS(3)                 POSIX Programmer's Manual                WCTRANS(3)



PPRROOLLOOGG
       This manual page is part of the POSIX Programmer's Manual.  The OS
       implementation of this interface may differ (consult the corresponding
       OS manual page for details of OS behavior), or the interface may not be
       implemented on OS.


NNAAMMEE
       wctrans, wctrans_l -- define character mapping

SSYYNNOOPPSSIISS
       #include <wctype.h>

       wctrans_t wctrans(const char *_c_h_a_r_c_l_a_s_s);
       wctrans_t wctrans_l(const char *_c_h_a_r_c_l_a_s_s, locale_t _l_o_c_a_l_e);

DDEESSCCRRIIPPTTIIOONN
       For _w_c_t_r_a_n_s(): The functionality described on this reference page is
       aligned with the ISO C standard. Any conflict between the requirements
       described here and the ISO C standard is unintentional. This volume of
       POSIX.1-2008 defers to the ISO C standard.

       The _w_c_t_r_a_n_s() and _w_c_t_r_a_n_s___l() functions are defined for valid character
       mapping names identified in the current locale. The _c_h_a_r_c_l_a_s_s is a
       string identifying a generic character mapping name for which codeset-
       specific information is required. The following character mapping names
       are defined in all locales: ttoolloowweerr and ttoouuppppeerr.

       These functions shall return a value of type wwccttrraannss__tt, which can be
       used as the second argument to subsequent calls of _t_o_w_c_t_r_a_n_s() and
       _t_o_w_c_t_r_a_n_s___l().

       The _w_c_t_r_a_n_s() and _w_c_t_r_a_n_s___l() functions shall determine values of
       wwccttrraannss__tt according to the rules of the coded character set defined by
       character mapping information in the current locale or in the locale
       represented by _l_o_c_a_l_e, respectively (category _L_C___C_T_Y_P_E).

       The values returned by _w_c_t_r_a_n_s() shall be valid until a call to
       _s_e_t_l_o_c_a_l_e() that modifies the category _L_C___C_T_Y_P_E.

       The values returned by _w_c_t_r_a_n_s___l() shall be valid only in calls to
       _t_o_w_c_t_r_a_n_s___l() with a locale represented by _l_o_c_a_l_e with the same
       _L_C___C_T_Y_P_E category value.

       The behavior is undefined if the _l_o_c_a_l_e argument to _w_c_t_r_a_n_s___l() is the
       special locale object LC_GLOBAL_LOCALE or is not a valid locale object
       handle.

RREETTUURRNN VVAALLUUEE
       The _w_c_t_r_a_n_s() and _w_c_t_r_a_n_s___l() functions shall return 0 and may set
       _e_r_r_n_o to indicate the error if the given character mapping name is not
       valid for the current locale (category _L_C___C_T_Y_P_E); otherwise, they shall
       return a non-zero object of type wwccttrraannss__tt that can be used in calls to
       _t_o_w_c_t_r_a_n_s() and _t_o_w_c_t_r_a_n_s___l().

EERRRROORRSS
       These functions may fail if:

       EEIINNVVAALL The character mapping name pointed to by _c_h_a_r_c_l_a_s_s is not valid
              in the current locale.

       _T_h_e _f_o_l_l_o_w_i_n_g _s_e_c_t_i_o_n_s _a_r_e _i_n_f_o_r_m_a_t_i_v_e_.

EEXXAAMMPPLLEESS
       None.

AAPPPPLLIICCAATTIIOONN UUSSAAGGEE
       None.

RRAATTIIOONNAALLEE
       None.

FFUUTTUURREE DDIIRREECCTTIIOONNSS
       None.

SSEEEE AALLSSOO
       _t_o_w_c_t_r_a_n_s()

       The Base Definitions volume of POSIX.1-2008, <<wwccttyyppee..hh>>

CCOOPPYYRRIIGGHHTT
       Portions of this text are reprinted and reproduced in electronic form
       from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology
       -- Portable Operating System Interface (POSIX), The Open Group Base
       Specifications Issue 7, Copyright (C) 2013 by the Institute of
       Electrical and Electronics Engineers, Inc and The Open Group.  (This is
       POSIX.1-2008 with the 2013 Technical Corrigendum 1 applied.) In the
       event of any discrepancy between this version 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.unix.org/online.html .

       Any typographical or formatting errors that appear in this page are
       most likely to have been introduced during the conversion of the source
       files to man page format. To report such errors, see
       https://www.kernel.org/doc/man-pages/reporting_bugs.html .



IEEE/The Open Group                  2013                           WCTRANS(3)
