tools/pcre/doc/pcre_refcount.3
author Nicholas Hastings <skamonkey@gmail.com>
Sun Jul 15 12:31:06 2012 -0400 (2012-07-15)
changeset 3579 6d730190a3e4
parent 2762 d2d467bf1b5a
child 3831 babd0eee3c5e
permissions -rw-r--r--
Added missing files to each core and logic makefiles (NPOTB).
dvander@2762
     1
.TH PCRE_REFCOUNT 3
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);
dvander@2762
    11
.
dvander@2762
    12
.SH DESCRIPTION
dvander@2762
    13
.rs
dvander@2762
    14
.sp
dvander@2762
    15
This function is used to maintain a reference count inside a data block that
dvander@2762
    16
contains a compiled pattern. Its arguments are:
dvander@2762
    17
.sp
dvander@2762
    18
  \fIcode\fP                      Compiled regular expression
dvander@2762
    19
  \fIadjust\fP                    Adjustment to reference value
dvander@2762
    20
.sp
dvander@2762
    21
The yield of the function is the adjusted reference value, which is constrained
dvander@2762
    22
to lie between 0 and 65535.
dvander@2762
    23
.P
dvander@2762
    24
There is a complete description of the PCRE native API in the
dvander@2762
    25
.\" HREF
dvander@2762
    26
\fBpcreapi\fP
dvander@2762
    27
.\"
dvander@2762
    28
page and a description of the POSIX API in the
dvander@2762
    29
.\" HREF
dvander@2762
    30
\fBpcreposix\fP
dvander@2762
    31
.\"
dvander@2762
    32
page.