/[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 954 - (show annotations)
Sat Mar 31 18:09:26 2012 UTC (7 years, 4 months ago) by ph10
File size: 1259 byte(s)
Add date and PCRE version to .TH macros of all man pages.
1 .TH PCRE_PATTERN_TO_HOST_BYTE_ORDER 3 "21 January 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 .SM
10 .B int pcre_pattern_to_host_byte_order(pcre *\fIcode\fP,
11 .ti +5n
12 .B pcre_extra *\fIextra\fP, const unsigned char *\fItables\fP);
13 .PP
14 .B int pcre16_pattern_to_host_byte_order(pcre16 *\fIcode\fP,
15 .ti +5n
16 .B pcre16_extra *\fIextra\fP, const unsigned char *\fItables\fP);
17 .
18 .
19 .SH DESCRIPTION
20 .rs
21 .sp
22 This function ensures that the bytes in 2-byte and 4-byte values in a compiled
23 pattern are in the correct order for the current host. It is useful when a
24 pattern that has been compiled on one host is transferred to another that might
25 have different endianness. The arguments are:
26 .sp
27 \fIcode\fP A compiled regular expression
28 \fIextra\fP Points to an associated \fBpcre[16]_extra\fP structure,
29 or is NULL
30 \fItables\fP Pointer to character tables, or NULL to
31 set the built-in default
32 .sp
33 The result is 0 for success, a negative PCRE_ERROR_xxx value otherwise.
34 .P
35 There is a complete description of the PCRE native API in the
36 .\" HREF
37 \fBpcreapi\fP
38 .\"
39 page and a description of the POSIX API in the
40 .\" HREF
41 \fBpcreposix\fP
42 .\"
43 page.

  ViewVC Help
Powered by ViewVC 1.1.5