Return to pcre_pattern_to_host_byte_order.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / pcre / doc

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

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
                      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);
1.1.1.3 ! misho      17: .PP
        !            18: .B int pcre32_pattern_to_host_byte_order(pcre32 *\fIcode\fP,
        !            19: .ti +5n
        !            20: .B pcre32_extra *\fIextra\fP, const unsigned char *\fItables\fP);
1.1       misho      21: .
                     22: .SH DESCRIPTION
                     23: .rs
                     24: .sp
                     25: This function ensures that the bytes in 2-byte and 4-byte values in a compiled
                     26: pattern are in the correct order for the current host. It is useful when a
                     27: pattern that has been compiled on one host is transferred to another that might
                     28: have different endianness. The arguments are:
                     29: .sp
                     30:   \fIcode\fP         A compiled regular expression
1.1.1.3 ! misho      31:   \fIextra\fP        Points to an associated \fBpcre[16|32]_extra\fP structure,
1.1       misho      32:                  or is NULL
                     33:   \fItables\fP       Pointer to character tables, or NULL to
                     34:                  set the built-in default
                     35: .sp
                     36: The result is 0 for success, a negative PCRE_ERROR_xxx value otherwise.
                     37: .P
                     38: There is a complete description of the PCRE native API in the
                     39: .\" HREF
                     40: \fBpcreapi\fP
                     41: .\"
                     42: page and a description of the POSIX API in the
                     43: .\" HREF
                     44: \fBpcreposix\fP
                     45: .\"
                     46: page.