diff options
author | ph10 <ph10@2f5784b3-3f2a-0410-8824-cb99058d5e15> | 2012-01-14 11:23:25 +0000 |
---|---|---|
committer | ph10 <ph10@2f5784b3-3f2a-0410-8824-cb99058d5e15> | 2012-01-14 11:23:25 +0000 |
commit | 32925a47941f651ab158479c977828875c478348 (patch) | |
tree | eb1f08293f6ddc969e5732d8d13082075f4d71e0 /doc/pcre_utf16_to_host_byte_order.3 | |
parent | 57607b5518c705150a68606724fb875c7ba2686f (diff) | |
download | pcre-32925a47941f651ab158479c977828875c478348.tar.gz |
Documentation correction.
git-svn-id: svn://vcs.exim.org/pcre/code/trunk@870 2f5784b3-3f2a-0410-8824-cb99058d5e15
Diffstat (limited to 'doc/pcre_utf16_to_host_byte_order.3')
-rw-r--r-- | doc/pcre_utf16_to_host_byte_order.3 | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/doc/pcre_utf16_to_host_byte_order.3 b/doc/pcre_utf16_to_host_byte_order.3 index 158aaea..557d208 100644 --- a/doc/pcre_utf16_to_host_byte_order.3 +++ b/doc/pcre_utf16_to_host_byte_order.3 @@ -9,7 +9,7 @@ PCRE - Perl-compatible regular expressions .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 @@ 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 - \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 |