1PCRE_UTF32_TO_HOST_BYTE_ORDELRi(b3r)ary Functions MaPnCuRaEl_UTF32_TO_HOST_BYTE_ORDER(3)
2
3
4
6 PCRE - Perl-compatible regular expressions
7
9
10 #include <pcre.h>
11
12 int pcre32_utf32_to_host_byte_order(PCRE_UCHAR32 *output,
13 PCRE_SPTR32 input, int length, int *host_byte_order,
14 int keep_boms);
15
17
18 This function, which exists only in the 32-bit library, converts a
19 UTF-32 string to the correct order for the current host, taking account
20 of any byte order marks (BOMs) within the string. Its arguments are:
21
22 output pointer to output buffer, may be the same as input
23 input pointer to input buffer
24 length number of 32-bit units in the input, or negative for
25 a zero-terminated string
26 host_byte_order a NULL value or a non-zero value pointed to means
27 start in host byte order
28 keep_boms if non-zero, BOMs are copied to the output string
29
30 The result of the function is the number of 32-bit units placed into
31 the output buffer, including the zero terminator if the string was
32 zero-terminated.
33
34 If host_byte_order is not NULL, it is set to indicate the byte order
35 that is current at the end of the string.
36
37 There is a complete description of the PCRE native API in the pcreapi
38 page and a description of the POSIX API in the pcreposix page.
39
40
41
42PCRE 8.30 24 June 2012 PCRE_UTF32_TO_HOST_BYTE_ORDER(3)