Revision: 870
http://vcs.pcre.org/viewvc?view=rev&revision=870
Author: ph10
Date: 2012-01-14 11:23:25 +0000 (Sat, 14 Jan 2012)
Log Message:
-----------
Documentation correction.
Modified Paths:
--------------
code/trunk/doc/pcre_utf16_to_host_byte_order.3
Modified: code/trunk/doc/pcre_utf16_to_host_byte_order.3
===================================================================
--- code/trunk/doc/pcre_utf16_to_host_byte_order.3 2012-01-14 11:16:23 UTC (rev 869)
+++ code/trunk/doc/pcre_utf16_to_host_byte_order.3 2012-01-14 11:23:25 UTC (rev 870)
@@ -9,7 +9,7 @@
.SM
.B int pcre16_utf16_to_host_byte_order(PCRE_UCHAR16 *\fIoutput\fP,
.ti +5n
-.B PCRE_SPTR16 \fIinput\fP, int \fIlength\fP, int *\fIbyte_order\fP,
+.B PCRE_SPTR16 \fIinput\fP, int \fIlength\fP, int *\fIhost_byte_order\fP,
.ti +5n
.B int \fIkeep_boms\fP);
.
@@ -21,19 +21,19 @@
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
- \fIbyte_order\fP a NULL value or a value of 0 pointed to means start
- in host byte order
- \fIkeep_boms\fP if non-zero, BOMs are copied to the output string
+ \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 \fIbyte_order\fP is not NULL, it is set to indicate the byte order that is
-current at the end of the string.
+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
