src/external/pcre2-10.32/doc/html/pcre2_set_newline.html

   1 <html>
   2 <head>
   3 <title>pcre2_set_newline specification</title>
   4 </head>
   5 <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB">
   6 <h1>pcre2_set_newline man page</h1>
   7 <p>
   8 Return to the <a href="index.html">PCRE2 index page</a>.
   9 </p>
  10 <p>
  11 This page is part of the PCRE2 HTML documentation. It was generated
  12 automatically from the original man page. If there is any nonsense in it,
  13 please consult the man page, in case the conversion went wrong.
  14 <br>
  15 <br><b>
  16 SYNOPSIS
  17 </b><br>
  18 <P>
  19 <b>#include &#60;pcre2.h&#62;</b>
  20 </P>
  21 <P>
  22 <b>int pcre2_set_newline(pcre2_compile_context *<i>ccontext</i>,</b>
  23 <b>  uint32_t <i>value</i>);</b>
  24 </P>
  25 <br><b>
  26 DESCRIPTION
  27 </b><br>
  28 <P>
  29 This function sets the newline convention within a compile context. This
  30 specifies which character(s) are recognized as newlines when compiling and
  31 matching patterns. The second argument must be one of:
  32 <pre>
  33   PCRE2_NEWLINE_CR        Carriage return only
  34   PCRE2_NEWLINE_LF        Linefeed only
  35   PCRE2_NEWLINE_CRLF      CR followed by LF only
  36   PCRE2_NEWLINE_ANYCRLF   Any of the above
  37   PCRE2_NEWLINE_ANY       Any Unicode newline sequence
  38   PCRE2_NEWLINE_NUL       The NUL character (binary zero)
  39 </pre>
  40 The result is zero for success or PCRE2_ERROR_BADDATA if the second argument is
  41 invalid.
  42 </P>
  43 <P>
  44 There is a complete description of the PCRE2 native API in the
  45 <a href="pcre2api.html"><b>pcre2api</b></a>
  46 page and a description of the POSIX API in the
  47 <a href="pcre2posix.html"><b>pcre2posix</b></a>
  48 page.
  49 <p>
  50 Return to the <a href="index.html">PCRE2 index page</a>.
  51 </p>