pcre_utf16_to_host_byte_order(3) — Linux manual page

NAME \| SYNOPSIS \| DESCRIPTION \| COLOPHON

PCRE_UTF16_TO_HOST_BYTE_ORDER(3)FunctionsCManual16_TO_HOST_BYTE_ORDER(3)

NAME top

       PCRE - Perl-compatible regular expressions

SYNOPSIS top


       #include <pcre.h>

       int pcre16_utf16_to_host_byte_order(PCRE_UCHAR16 *output,
            PCRE_SPTR16 input, int length, int *host_byte_order,
            int keep_boms);

DESCRIPTION top


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

         output           pointer to output buffer, may be the same as
       input
         input            pointer to input buffer
         length           number of 16-bit units in the input, or
       negative for
                            a zero-terminated string
         host_byte_order  a NULL value or a non-zero value pointed to
       means
                            start in host byte order
         keep_boms        if non-zero, BOMs are copied to the output
       string

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

       If host_byte_order 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
       pcreapi page and a description of the POSIX API in the pcreposix
       page.

COLOPHON top

       This page is part of the PCRE (Perl Compatible Regular
       Expressions) project.  Information about the project can be found
       at ⟨http://www.pcre.org/⟩.  If you have a bug report for this
       manual page, see
       ⟨http://bugs.exim.org/enter_bug.cgi?product=PCRE⟩.  This page was
       obtained from the tarball pcre-8.45.tar.gz fetched from
       ⟨ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/⟩ on
       2021-08-27.  If you discover any rendering problems in this HTML
       version of the page, or you believe there is a better or more up-
       to-date source for the page, or you have corrections or
       improvements to the information in this COLOPHON (which is not
       part of the original manual page), send a mail to
       man-pages@man7.org

PCRE 8.30                    21 January 2P0C1R2E_UTF16_TO_HOST_BYTE_ORDER(3)