pcre2_match_data_free.3 1.0 KB

1234567891011121314151617181920212223242526272829303132333435
  1. .TH PCRE2_MATCH_DATA_FREE 3 "18 January 2023" "PCRE2 10.43"
  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 void pcre2_match_data_free(pcre2_match_data *\fImatch_data\fP);
  11. .fi
  12. .
  13. .SH DESCRIPTION
  14. .rs
  15. .sp
  16. If \fImatch_data\fP is NULL, this function does nothing. Otherwise,
  17. \fImatch_data\fP must point to a match data block, which this function frees,
  18. using the memory freeing function from the general context or compiled pattern
  19. with which it was created, or \fBfree()\fP if that was not set. If the match
  20. data block was previously passed to \fBpcre2_match()\fP, it will have an
  21. attached heapframe vector; this is also freed.
  22. .P
  23. If the PCRE2_COPY_MATCHED_SUBJECT was used for a successful match using this
  24. match data block, the copy of the subject that was referenced within the block
  25. is also freed.
  26. .P
  27. There is a complete description of the PCRE2 native API in the
  28. .\" HREF
  29. \fBpcre2api\fP
  30. .\"
  31. page and a description of the POSIX API in the
  32. .\" HREF
  33. \fBpcre2posix\fP
  34. .\"
  35. page.