AnonymousFox

//opt/pcre/share/doc/pcre/html/pcre_utf16_to_host_byte_order.html

<html>
<head>
<title>pcre_utf16_to_host_byte_order specification</title>
</head>
<body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
<h1>pcre_utf16_to_host_byte_order man page</h1>

Return to the <a href="index.html">PCRE index page</a>.


This page is part of the PCRE HTML documentation. It was generated automatically
from the original man page. If there is any nonsense in it, please consult the
man page, in case the conversion went wrong.
 
 
SYNOPSIS
 

#include &#60;pcre.h&#62;


int pcre16_utf16_to_host_byte_order(PCRE_UCHAR16 *output,
 PCRE_SPTR16 input, int length, int *host_byte_order,
 int keep_boms);

 
DESCRIPTION
 

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:
<pre>
 output pointer to output buffer, may be the same as input
 input pointer to input buffer
 length number of 16-bit units in the input, or negative for
 a zero-terminated string
 host_byte_order a NULL value or a non-zero value pointed to means
 start in host byte order
 keep_boms if non-zero, BOMs are copied to the output string
</pre>
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.


If host_byte_order is not NULL, it is set to indicate the byte order that
is current at the end of the string.


There is a complete description of the PCRE native API in the
<a href="pcreapi.html">pcreapi</a>
page and a description of the POSIX API in the
<a href="pcreposix.html">pcreposix</a>
page.

Return to the <a href="index.html">PCRE index page</a>.