STRXFRM(3)                 POSIX Programmer's Manual                STRXFRM(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
       strxfrm, strxfrm_l -- string transformation

SSYYNNOOPPSSIISS
       #include <string.h>

       size_t strxfrm(char *restrict _s_1, const char *restrict _s_2, size_t _n);
       size_t strxfrm_l(char *restrict _s_1, const char *restrict _s_2,
           size_t _n, locale_t _l_o_c_a_l_e);

DDEESSCCRRIIPPTTIIOONN
       For _s_t_r_x_f_r_m(): 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-2017 defers to the ISO C standard.

       The _s_t_r_x_f_r_m() and _s_t_r_x_f_r_m___l() functions shall transform the string
       pointed to by _s_2 and place the resulting string into the array pointed
       to by _s_1.  The transformation is such that if _s_t_r_c_m_p() is applied to
       two transformed strings, it shall return a value greater than, equal
       to, or less than 0, corresponding to the result of _s_t_r_c_o_l_l() or
       _s_t_r_c_o_l_l___l(), respectively, applied to the same two original strings
       with the same locale.  No more than _n bytes are placed into the
       resulting array pointed to by _s_1, including the terminating NUL
       character. If _n is 0, _s_1 is permitted to be a null pointer. If copying
       takes place between objects that overlap, the behavior is undefined.

       The _s_t_r_x_f_r_m() and _s_t_r_x_f_r_m___l() functions shall not change the setting of
       _e_r_r_n_o if successful.

       Since no return value is reserved to indicate an error, an application
       wishing to check for error situations should set _e_r_r_n_o to 0, then call
       _s_t_r_x_f_r_m() or _s_t_r_x_f_r_m___l(), then check _e_r_r_n_o.

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

RREETTUURRNN VVAALLUUEE
       Upon successful completion, _s_t_r_x_f_r_m() and _s_t_r_x_f_r_m___l() shall return the
       length of the transformed string (not including the terminating NUL
       character). If the value returned is _n or more, the contents of the
       array pointed to by _s_1 are unspecified.

       On error, _s_t_r_x_f_r_m() and _s_t_r_x_f_r_m___l() may set _e_r_r_n_o but no return value
       is reserved to indicate an error.

EERRRROORRSS
       These functions may fail if:

       EEIINNVVAALL The string pointed to by the _s_2 argument contains characters
              outside the domain of the collating sequence.

       _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
       The transformation function is such that two transformed strings can be
       ordered by _s_t_r_c_m_p() as appropriate to collating sequence information in
       the current locale (category _L_C___C_O_L_L_A_T_E).

       The fact that when _n is 0 _s_1 is permitted to be a null pointer is
       useful to determine the size of the _s_1 array prior to making the
       transformation.

RRAATTIIOONNAALLEE
       None.

FFUUTTUURREE DDIIRREECCTTIIOONNSS
       None.

SSEEEE AALLSSOO
       _s_t_r_c_m_p(), _s_t_r_c_o_l_l()

       The Base Definitions volume of POSIX.1-2017, <<ssttrriinngg..hh>>

CCOOPPYYRRIIGGHHTT
       Portions of this text are reprinted and reproduced in electronic form
       from IEEE Std 1003.1-2017, Standard for Information Technology --
       Portable Operating System Interface (POSIX), The Open Group Base
       Specifications Issue 7, 2018 Edition, Copyright (C) 2018 by the
       Institute of Electrical and Electronics Engineers, Inc and The Open
       Group.  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.opengroup.org/unix/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                  2017                           STRXFRM(3)
