trunk/doc/pcre_utf16_to_host_byte_order.3

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