pcre2_set_newline.3 1.0 KB

123456789101112131415161718192021222324252627282930313233343536373839
  1. .TH PCRE2_SET_NEWLINE 3 "26 May 2017" "PCRE2 10.30"
  2. .SH NAME
  3. PCRE2 - Perl-compatible regular expressions (revised API)
  4. .SH SYNOPSIS
  5. .rs
  6. .sp
  7. .B #include <pcre2.h>
  8. .PP
  9. .nf
  10. .B int pcre2_set_newline(pcre2_compile_context *\fIccontext\fP,
  11. .B " uint32_t \fIvalue\fP);"
  12. .fi
  13. .
  14. .SH DESCRIPTION
  15. .rs
  16. .sp
  17. This function sets the newline convention within a compile context. This
  18. specifies which character(s) are recognized as newlines when compiling and
  19. matching patterns. The second argument must be one of:
  20. .sp
  21. PCRE2_NEWLINE_CR Carriage return only
  22. PCRE2_NEWLINE_LF Linefeed only
  23. PCRE2_NEWLINE_CRLF CR followed by LF only
  24. PCRE2_NEWLINE_ANYCRLF Any of the above
  25. PCRE2_NEWLINE_ANY Any Unicode newline sequence
  26. PCRE2_NEWLINE_NUL The NUL character (binary zero)
  27. .sp
  28. The result is zero for success or PCRE2_ERROR_BADDATA if the second argument is
  29. invalid.
  30. .P
  31. There is a complete description of the PCRE2 native API in the
  32. .\" HREF
  33. \fBpcre2api\fP
  34. .\"
  35. page and a description of the POSIX API in the
  36. .\" HREF
  37. \fBpcre2posix\fP
  38. .\"
  39. page.