Annotation of embedaddon/pcre/doc/pcre_pattern_to_host_byte_order.3, revision 1.1.1.4

1.1.1.3   misho       1: .TH PCRE_PATTERN_TO_HOST_BYTE_ORDER 3 "24 June 2012" "PCRE 8.30"
1.1       misho       2: .SH NAME
                      3: PCRE - Perl-compatible regular expressions
                      4: .SH SYNOPSIS
                      5: .rs
                      6: .sp
                      7: .B #include <pcre.h>
                      8: .PP
1.1.1.4 ! misho       9: .nf
1.1       misho      10: .B int pcre_pattern_to_host_byte_order(pcre *\fIcode\fP,
1.1.1.4 ! misho      11: .B "     pcre_extra *\fIextra\fP, const unsigned char *\fItables\fP);"
        !            12: .sp
1.1       misho      13: .B int pcre16_pattern_to_host_byte_order(pcre16 *\fIcode\fP,
1.1.1.4 ! misho      14: .B "     pcre16_extra *\fIextra\fP, const unsigned char *\fItables\fP);"
        !            15: .sp
1.1.1.3   misho      16: .B int pcre32_pattern_to_host_byte_order(pcre32 *\fIcode\fP,
1.1.1.4 ! misho      17: .B "     pcre32_extra *\fIextra\fP, const unsigned char *\fItables\fP);"
        !            18: .fi
1.1       misho      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
1.1.1.3   misho      29:   \fIextra\fP        Points to an associated \fBpcre[16|32]_extra\fP structure,
1.1       misho      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.

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>