Blame doc/pcre_pattern_to_host_byte_order.3

Packit 78a954
.TH PCRE_PATTERN_TO_HOST_BYTE_ORDER 3 "24 June 2012" "PCRE 8.30"
Packit 78a954
.SH NAME
Packit 78a954
PCRE - Perl-compatible regular expressions
Packit 78a954
.SH SYNOPSIS
Packit 78a954
.rs
Packit 78a954
.sp
Packit 78a954
.B #include <pcre.h>
Packit 78a954
.PP
Packit 78a954
.nf
Packit 78a954
.B int pcre_pattern_to_host_byte_order(pcre *\fIcode\fP,
Packit 78a954
.B "     pcre_extra *\fIextra\fP, const unsigned char *\fItables\fP);"
Packit 78a954
.sp
Packit 78a954
.B int pcre16_pattern_to_host_byte_order(pcre16 *\fIcode\fP,
Packit 78a954
.B "     pcre16_extra *\fIextra\fP, const unsigned char *\fItables\fP);"
Packit 78a954
.sp
Packit 78a954
.B int pcre32_pattern_to_host_byte_order(pcre32 *\fIcode\fP,
Packit 78a954
.B "     pcre32_extra *\fIextra\fP, const unsigned char *\fItables\fP);"
Packit 78a954
.fi
Packit 78a954
.
Packit 78a954
.SH DESCRIPTION
Packit 78a954
.rs
Packit 78a954
.sp
Packit 78a954
This function ensures that the bytes in 2-byte and 4-byte values in a compiled
Packit 78a954
pattern are in the correct order for the current host. It is useful when a
Packit 78a954
pattern that has been compiled on one host is transferred to another that might
Packit 78a954
have different endianness. The arguments are:
Packit 78a954
.sp
Packit 78a954
  \fIcode\fP         A compiled regular expression
Packit 78a954
  \fIextra\fP        Points to an associated \fBpcre[16|32]_extra\fP structure,
Packit 78a954
                 or is NULL
Packit 78a954
  \fItables\fP       Pointer to character tables, or NULL to
Packit 78a954
                 set the built-in default
Packit 78a954
.sp
Packit 78a954
The result is 0 for success, a negative PCRE_ERROR_xxx value otherwise.
Packit 78a954
.P
Packit 78a954
There is a complete description of the PCRE native API in the
Packit 78a954
.\" HREF
Packit 78a954
\fBpcreapi\fP
Packit 78a954
.\"
Packit 78a954
page and a description of the POSIX API in the
Packit 78a954
.\" HREF
Packit 78a954
\fBpcreposix\fP
Packit 78a954
.\"
Packit 78a954
page.