/[pcre]/code/trunk/doc/pcre_utf32_to_host_byte_order.3
ViewVC logotype

Contents of /code/trunk/doc/pcre_utf32_to_host_byte_order.3

Parent Directory Parent Directory | Revision Log Revision Log


Revision 1339 - (show annotations)
Fri Jun 14 09:09:28 2013 UTC (6 years ago) by ph10
File size: 1491 byte(s)
Update man pages to avoid the use of .ti (which causes difficulties for some 
translation software).
1 .TH PCRE_UTF32_TO_HOST_BYTE_ORDER 3 "24 June 2012" "PCRE 8.30"
2 .SH NAME
3 PCRE - Perl-compatible regular expressions
4 .SH SYNOPSIS
5 .rs
6 .sp
7 .B #include <pcre.h>
8 .PP
9 .nf
10 .B int pcre32_utf32_to_host_byte_order(PCRE_UCHAR32 *\fIoutput\fP,
11 .B " PCRE_SPTR32 \fIinput\fP, int \fIlength\fP, int *\fIhost_byte_order\fP,"
12 .B " int \fIkeep_boms\fP);"
13 .fi
14 .
15 .
16 .SH DESCRIPTION
17 .rs
18 .sp
19 This function, which exists only in the 32-bit library, converts a UTF-32
20 string to the correct order for the current host, taking account of any byte
21 order marks (BOMs) within the string. Its arguments are:
22 .sp
23 \fIoutput\fP pointer to output buffer, may be the same as \fIinput\fP
24 \fIinput\fP pointer to input buffer
25 \fIlength\fP number of 32-bit units in the input, or negative for
26 a zero-terminated string
27 \fIhost_byte_order\fP a NULL value or a non-zero value pointed to means
28 start in host byte order
29 \fIkeep_boms\fP if non-zero, BOMs are copied to the output string
30 .sp
31 The result of the function is the number of 32-bit units placed into the output
32 buffer, including the zero terminator if the string was zero-terminated.
33 .P
34 If \fIhost_byte_order\fP is not NULL, it is set to indicate the byte order that
35 is current at the end of the string.
36 .P
37 There is a complete description of the PCRE native API in the
38 .\" HREF
39 \fBpcreapi\fP
40 .\"
41 page and a description of the POSIX API in the
42 .\" HREF
43 \fBpcreposix\fP
44 .\"
45 page.

  ViewVC Help
Powered by ViewVC 1.1.5