Return to pcre_utf16_to_host_byte_order.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / pcre / doc

Annotation of embedaddon/pcre/doc/pcre_utf16_to_host_byte_order.3, revision 1.1.1.3

1.1.1.2   misho       1: .TH PCRE_UTF16_TO_HOST_BYTE_ORDER 3 "21 January 2012" "PCRE 8.30"
1.1       misho       2: .SH NAME
                      3: PCRE - Perl-compatible regular expressions
                      4: .SH SYNOPSIS
                      5: .rs
                      6: .sp
                      7: .B #include <pcre.h>
                      8: .PP
1.1.1.3 ! misho       9: .nf
1.1       misho      10: .B int pcre16_utf16_to_host_byte_order(PCRE_UCHAR16 *\fIoutput\fP,
1.1.1.3 ! misho      11: .B "     PCRE_SPTR16 \fIinput\fP, int \fIlength\fP, int *\fIhost_byte_order\fP,"
        !            12: .B "     int \fIkeep_boms\fP);"
        !            13: .fi
1.1       misho      14: .
                     15: .
                     16: .SH DESCRIPTION
                     17: .rs
                     18: .sp
                     19: This function, which exists only in the 16-bit library, converts a UTF-16
                     20: string to the correct order for the current host, taking account of any byte
                     21: order marks (BOMs) within the string. Its arguments are:
                     22: .sp
                     23:   \fIoutput\fP           pointer to output buffer, may be the same as \fIinput\fP
                     24:   \fIinput\fP            pointer to input buffer
                     25:   \fIlength\fP           number of 16-bit units in the input, or negative for
                     26:                      a zero-terminated string
                     27:   \fIhost_byte_order\fP  a NULL value or a non-zero value pointed to means
                     28:                      start in host byte order
                     29:   \fIkeep_boms\fP        if non-zero, BOMs are copied to the output string
                     30: .sp
                     31: The result of the function is the number of 16-bit units placed into the output
                     32: buffer, including the zero terminator if the string was zero-terminated.
                     33: .P
                     34: If \fIhost_byte_order\fP is not NULL, it is set to indicate the byte order that
                     35: is current at the end of the string.
                     36: .P
                     37: There is a complete description of the PCRE native API in the
                     38: .\" HREF
                     39: \fBpcreapi\fP
                     40: .\"
                     41: page and a description of the POSIX API in the
                     42: .\" HREF
                     43: \fBpcreposix\fP
                     44: .\"
                     45: page.