| 1 |
<html>
|
| 2 |
<head>
|
| 3 |
<title>pcre_utf16_to_host_byte_order specification</title>
|
| 4 |
</head>
|
| 5 |
<body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
|
| 6 |
<h1>pcre_utf16_to_host_byte_order man page</h1>
|
| 7 |
<p>
|
| 8 |
Return to the <a href="index.html">PCRE index page</a>.
|
| 9 |
</p>
|
| 10 |
<p>
|
| 11 |
This page is part of the PCRE HTML documentation. It was generated automatically
|
| 12 |
from the original man page. If there is any nonsense in it, please consult the
|
| 13 |
man page, in case the conversion went wrong.
|
| 14 |
<br>
|
| 15 |
<br><b>
|
| 16 |
SYNOPSIS
|
| 17 |
</b><br>
|
| 18 |
<P>
|
| 19 |
<b>#include <pcre.h></b>
|
| 20 |
</P>
|
| 21 |
<P>
|
| 22 |
<b>int pcre16_utf16_to_host_byte_order(PCRE_UCHAR16 *<i>output</i>,</b>
|
| 23 |
<b>PCRE_SPTR16 <i>input</i>, int <i>length</i>, int *<i>host_byte_order</i>,</b>
|
| 24 |
<b>int <i>keep_boms</i>);</b>
|
| 25 |
</P>
|
| 26 |
<br><b>
|
| 27 |
DESCRIPTION
|
| 28 |
</b><br>
|
| 29 |
<P>
|
| 30 |
This function, which exists only in the 16-bit library, converts a UTF-16
|
| 31 |
string to the correct order for the current host, taking account of any byte
|
| 32 |
order marks (BOMs) within the string. Its arguments are:
|
| 33 |
<pre>
|
| 34 |
<i>output</i> pointer to output buffer, may be the same as <i>input</i>
|
| 35 |
<i>input</i> pointer to input buffer
|
| 36 |
<i>length</i> number of 16-bit units in the input, or negative for
|
| 37 |
a zero-terminated string
|
| 38 |
<i>host_byte_order</i> a NULL value or a non-zero value pointed to means
|
| 39 |
start in host byte order
|
| 40 |
<i>keep_boms</i> if non-zero, BOMs are copied to the output string
|
| 41 |
</pre>
|
| 42 |
The result of the function is the number of 16-bit units placed into the output
|
| 43 |
buffer, including the zero terminator if the string was zero-terminated.
|
| 44 |
</P>
|
| 45 |
<P>
|
| 46 |
If <i>host_byte_order</i> is not NULL, it is set to indicate the byte order that
|
| 47 |
is current at the end of the string.
|
| 48 |
</P>
|
| 49 |
<P>
|
| 50 |
There is a complete description of the PCRE native API in the
|
| 51 |
<a href="pcreapi.html"><b>pcreapi</b></a>
|
| 52 |
page and a description of the POSIX API in the
|
| 53 |
<a href="pcreposix.html"><b>pcreposix</b></a>
|
| 54 |
page.
|
| 55 |
<p>
|
| 56 |
Return to the <a href="index.html">PCRE index page</a>.
|
| 57 |
</p>
|
Parent Directory
| 
Revision Log