From 437835559168a5945a1196161660c439266eb59d Mon Sep 17 00:00:00 2001 From: George Hazan Date: Tue, 16 Jun 2015 11:04:10 +0000 Subject: unified project for pcre16 moved to libs git-svn-id: http://svn.miranda-ng.org/main/trunk@14195 1316c22d-e87f-b044-9b9b-93d7a3e3ba9c --- libs/Pcre16/docs/doc/pcre_copy_substring.3 | 47 ++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 libs/Pcre16/docs/doc/pcre_copy_substring.3 (limited to 'libs/Pcre16/docs/doc/pcre_copy_substring.3') diff --git a/libs/Pcre16/docs/doc/pcre_copy_substring.3 b/libs/Pcre16/docs/doc/pcre_copy_substring.3 new file mode 100644 index 0000000000..83af6e800a --- /dev/null +++ b/libs/Pcre16/docs/doc/pcre_copy_substring.3 @@ -0,0 +1,47 @@ +.TH PCRE_COPY_SUBSTRING 3 "24 June 2012" "PCRE 8.30" +.SH NAME +PCRE - Perl-compatible regular expressions +.SH SYNOPSIS +.rs +.sp +.B #include +.PP +.nf +.B int pcre_copy_substring(const char *\fIsubject\fP, int *\fIovector\fP, +.B " int \fIstringcount\fP, int \fIstringnumber\fP, char *\fIbuffer\fP," +.B " int \fIbuffersize\fP);" +.sp +.B int pcre16_copy_substring(PCRE_SPTR16 \fIsubject\fP, int *\fIovector\fP, +.B " int \fIstringcount\fP, int \fIstringnumber\fP, PCRE_UCHAR16 *\fIbuffer\fP," +.B " int \fIbuffersize\fP);" +.sp +.B int pcre32_copy_substring(PCRE_SPTR32 \fIsubject\fP, int *\fIovector\fP, +.B " int \fIstringcount\fP, int \fIstringnumber\fP, PCRE_UCHAR32 *\fIbuffer\fP," +.B " int \fIbuffersize\fP);" +.fi +. +.SH DESCRIPTION +.rs +.sp +This is a convenience function for extracting a captured substring into a given +buffer. The arguments are: +.sp + \fIsubject\fP Subject that has been successfully matched + \fIovector\fP Offset vector that \fBpcre[16|32]_exec()\fP used + \fIstringcount\fP Value returned by \fBpcre[16|32]_exec()\fP + \fIstringnumber\fP Number of the required substring + \fIbuffer\fP Buffer to receive the string + \fIbuffersize\fP Size of buffer +.sp +The yield is the length of the string, PCRE_ERROR_NOMEMORY if the buffer was +too small, or PCRE_ERROR_NOSUBSTRING if the string number is invalid. +.P +There is a complete description of the PCRE native API in the +.\" HREF +\fBpcreapi\fP +.\" +page and a description of the POSIX API in the +.\" HREF +\fBpcreposix\fP +.\" +page. -- cgit v1.2.3