PCRE_UTF32_TO_HOST_BYTE_ORDELRi(b3r)ary Functions MaPnCuRaEl_UTF32_TO_HOST_BYTE_ORDER(3)



NNAAMMEE
       PCRE - Perl-compatible regular expressions

SSYYNNOOPPSSIISS

       ##iinncclluuddee <<ppccrree..hh>>

       iinntt ppccrree3322__uuttff3322__ttoo__hhoosstt__bbyyttee__oorrddeerr((PPCCRREE__UUCCHHAARR3322 **_o_u_t_p_u_t,,
            PPCCRREE__SSPPTTRR3322 _i_n_p_u_t,, iinntt _l_e_n_g_t_h,, iinntt **_h_o_s_t___b_y_t_e___o_r_d_e_r,,
            iinntt _k_e_e_p___b_o_m_s));;

DDEESSCCRRIIPPTTIIOONN

       This  function,  which  exists  only  in the 32-bit library, converts a
       UTF-32 string to the correct order for the current host, taking account
       of any byte order marks (BOMs) within the string. Its arguments are:

         _o_u_t_p_u_t           pointer to output buffer, may be the same as _i_n_p_u_t
         _i_n_p_u_t            pointer to input buffer
         _l_e_n_g_t_h           number of 32-bit units in the input, or negative for
                            a zero-terminated string
         _h_o_s_t___b_y_t_e___o_r_d_e_r  a NULL value or a non-zero value pointed to means
                            start in host byte order
         _k_e_e_p___b_o_m_s        if non-zero, BOMs are copied to the output string

       The  result  of  the function is the number of 32-bit units placed into
       the output buffer, including the zero  terminator  if  the  string  was
       zero-terminated.

       If  _h_o_s_t___b_y_t_e___o_r_d_e_r  is  not NULL, it is set to indicate the byte order
       that is current at the end of the string.

       There is a complete description of the PCRE native API in  the  ppccrreeaappii
       page and a description of the POSIX API in the ppccrreeppoossiixx page.



PCRE 8.30                        24 June 2012 PCRE_UTF32_TO_HOST_BYTE_ORDER(3)