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

Contents of /code/trunk/doc/pcre_pattern_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, 4 months ago) by ph10
File size: 1397 byte(s)
Update man pages to avoid the use of .ti (which causes difficulties for some 
translation software).
1 .TH PCRE_PATTERN_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 pcre_pattern_to_host_byte_order(pcre *\fIcode\fP,
11 .B " pcre_extra *\fIextra\fP, const unsigned char *\fItables\fP);"
12 .sp
13 .B int pcre16_pattern_to_host_byte_order(pcre16 *\fIcode\fP,
14 .B " pcre16_extra *\fIextra\fP, const unsigned char *\fItables\fP);"
15 .sp
16 .B int pcre32_pattern_to_host_byte_order(pcre32 *\fIcode\fP,
17 .B " pcre32_extra *\fIextra\fP, const unsigned char *\fItables\fP);"
18 .fi
19 .
20 .SH DESCRIPTION
21 .rs
22 .sp
23 This function ensures that the bytes in 2-byte and 4-byte values in a compiled
24 pattern are in the correct order for the current host. It is useful when a
25 pattern that has been compiled on one host is transferred to another that might
26 have different endianness. The arguments are:
27 .sp
28 \fIcode\fP A compiled regular expression
29 \fIextra\fP Points to an associated \fBpcre[16|32]_extra\fP structure,
30 or is NULL
31 \fItables\fP Pointer to character tables, or NULL to
32 set the built-in default
33 .sp
34 The result is 0 for success, a negative PCRE_ERROR_xxx value otherwise.
35 .P
36 There is a complete description of the PCRE native API in the
37 .\" HREF
38 \fBpcreapi\fP
39 .\"
40 page and a description of the POSIX API in the
41 .\" HREF
42 \fBpcreposix\fP
43 .\"
44 page.

  ViewVC Help
Powered by ViewVC 1.1.5