doc/html/pcre_pattern_to_host_byte_order.html

   1 <html>
   2 <head>
   3 <title>pcre_pattern_to_host_byte_order specification</title>
   4 </head>
   5 <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
   6 <h1>pcre_pattern_to_host_byte_order man page</h1>
   7 <p>
   8 Return to the <a href="index.html">PCRE index page</a>.
   9 </p>
  10 <p>
  11 This page is part of the PCRE HTML documentation. It was generated automatically
  12 from the original man page. If there is any nonsense in it, please consult the
  13 man page, in case the conversion went wrong.
  14 <br>
  15 <br><b>
  16 SYNOPSIS
  17 </b><br>
  18 <P>
  19 <b>#include &#60;pcre.h&#62;</b>
  20 </P>
  21 <P>
  22 <b>int pcre_pattern_to_host_byte_order(pcre *<i>code</i>,</b>
  23 <b>     pcre_extra *<i>extra</i>, const unsigned char *<i>tables</i>);</b>
  24 <br>
  25 <br>
  26 <b>int pcre16_pattern_to_host_byte_order(pcre16 *<i>code</i>,</b>
  27 <b>     pcre16_extra *<i>extra</i>, const unsigned char *<i>tables</i>);</b>
  28 <br>
  29 <br>
  30 <b>int pcre32_pattern_to_host_byte_order(pcre32 *<i>code</i>,</b>
  31 <b>     pcre32_extra *<i>extra</i>, const unsigned char *<i>tables</i>);</b>
  32 </P>
  33 <br><b>
  34 DESCRIPTION
  35 </b><br>
  36 <P>
  37 This function ensures that the bytes in 2-byte and 4-byte values in a compiled
  38 pattern are in the correct order for the current host. It is useful when a
  39 pattern that has been compiled on one host is transferred to another that might
  40 have different endianness. The arguments are:
  41 <pre>
  42   <i>code</i>         A compiled regular expression
  43   <i>extra</i>        Points to an associated <b>pcre[16|32]_extra</b> structure,
  44                  or is NULL
  45   <i>tables</i>       Pointer to character tables, or NULL to
  46                  set the built-in default
  47 </pre>
  48 The result is 0 for success, a negative PCRE_ERROR_xxx value otherwise.
  49 </P>
  50 <P>
  51 There is a complete description of the PCRE native API in the
  52 <a href="pcreapi.html"><b>pcreapi</b></a>
  53 page and a description of the POSIX API in the
  54 <a href="pcreposix.html"><b>pcreposix</b></a>
  55 page.
  56 <p>
  57 Return to the <a href="index.html">PCRE index page</a>.
  58 </p>