chiark / gitweb /
pcre3 (2:8.35-7.4) unstable; urgency=medium
[pcre3.git] / doc / pcre_refcount.3
1 .TH PCRE_REFCOUNT 3 "24 June 2012" "PCRE 8.30"
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_refcount(pcre *\fIcode\fP, int \fIadjust\fP);
11 .PP
12 .B int pcre16_refcount(pcre16 *\fIcode\fP, int \fIadjust\fP);
13 .PP
14 .B int pcre32_refcount(pcre32 *\fIcode\fP, int \fIadjust\fP);
15 .
16 .SH DESCRIPTION
17 .rs
18 .sp
19 This function is used to maintain a reference count inside a data block that
20 contains a compiled pattern. Its arguments are:
21 .sp
22   \fIcode\fP                      Compiled regular expression
23   \fIadjust\fP                    Adjustment to reference value
24 .sp
25 The yield of the function is the adjusted reference value, which is constrained
26 to lie between 0 and 65535.
27 .P
28 There is a complete description of the PCRE native API in the
29 .\" HREF
30 \fBpcreapi\fP
31 .\"
32 page and a description of the POSIX API in the
33 .\" HREF
34 \fBpcreposix\fP
35 .\"
36 page.