tools/pcre/doc/pcre_refcount.3
author Nicholas Hastings <skamonkey@gmail.com>
Sun Mar 17 11:32:03 2013 -0400 (2013-03-17)
changeset 3831 babd0eee3c5e
parent 2762 d2d467bf1b5a
permissions -rw-r--r--
Updated PCRE source to version 8.32 (bug 5593).
skamonkey@3831
     1
.TH PCRE_REFCOUNT 3 "24 June 2012" "PCRE 8.30"
dvander@2762
     2
.SH NAME
dvander@2762
     3
PCRE - Perl-compatible regular expressions
dvander@2762
     4
.SH SYNOPSIS
dvander@2762
     5
.rs
dvander@2762
     6
.sp
dvander@2762
     7
.B #include <pcre.h>
dvander@2762
     8
.PP
dvander@2762
     9
.SM
dvander@2762
    10
.B int pcre_refcount(pcre *\fIcode\fP, int \fIadjust\fP);
skamonkey@3831
    11
.PP
skamonkey@3831
    12
.B int pcre16_refcount(pcre16 *\fIcode\fP, int \fIadjust\fP);
skamonkey@3831
    13
.PP
skamonkey@3831
    14
.B int pcre32_refcount(pcre32 *\fIcode\fP, int \fIadjust\fP);
dvander@2762
    15
.
dvander@2762
    16
.SH DESCRIPTION
dvander@2762
    17
.rs
dvander@2762
    18
.sp
dvander@2762
    19
This function is used to maintain a reference count inside a data block that
dvander@2762
    20
contains a compiled pattern. Its arguments are:
dvander@2762
    21
.sp
dvander@2762
    22
  \fIcode\fP                      Compiled regular expression
dvander@2762
    23
  \fIadjust\fP                    Adjustment to reference value
dvander@2762
    24
.sp
dvander@2762
    25
The yield of the function is the adjusted reference value, which is constrained
dvander@2762
    26
to lie between 0 and 65535.
dvander@2762
    27
.P
dvander@2762
    28
There is a complete description of the PCRE native API in the
dvander@2762
    29
.\" HREF
dvander@2762
    30
\fBpcreapi\fP
dvander@2762
    31
.\"
dvander@2762
    32
page and a description of the POSIX API in the
dvander@2762
    33
.\" HREF
dvander@2762
    34
\fBpcreposix\fP
dvander@2762
    35
.\"
dvander@2762
    36
page.