--- code/trunk/doc/html/pcre_copy_named_substring.html 2007/02/24 21:40:03 63 +++ code/trunk/doc/html/pcre_copy_named_substring.html 2012/10/31 17:42:29 1194 @@ -3,9 +3,15 @@ pcre_copy_named_substring specification -This HTML document has been generated automatically from the original man page. -If there is any nonsense in it, please consult the man page, in case the -conversion went wrong.
+

pcre_copy_named_substring man page

+

+Return to the PCRE index page. +

+

+This page is part of the PCRE HTML documentation. It was generated automatically +from the original man page. If there is any nonsense in it, please consult the +man page, in case the conversion went wrong. +

SYNOPSIS
@@ -18,29 +24,42 @@ int stringcount, const char *stringname, char *buffer, int buffersize);

+

+int pcre16_copy_named_substring(const pcre16 *code, +PCRE_SPTR16 subject, int *ovector, +int stringcount, PCRE_SPTR16 stringname, +PCRE_UCHAR16 *buffer, int buffersize); +

+

+int pcre32_copy_named_substring(const pcre32 *code, +PCRE_SPTR32 subject, int *ovector, +int stringcount, PCRE_SPTR32 stringname, +PCRE_UCHAR32 *buffer, int buffersize); +


DESCRIPTION

This is a convenience function for extracting a captured substring, identified by name, into a given buffer. The arguments are: -

-

   code          Pattern that was successfully matched
   subject       Subject that has been successfully matched
-  ovector       Offset vector that pcre_exec() used
-  stringcount   Value returned by pcre_exec()
+  ovector       Offset vector that pcre[16|32]_exec() used
+  stringcount   Value returned by pcre[16|32]_exec()
   stringname    Name of the required substring
   buffer        Buffer to receive the string
   buffersize    Size of buffer
-
-

-

+ The yield is the length of the substring, PCRE_ERROR_NOMEMORY if the buffer was too small, or PCRE_ERROR_NOSUBSTRING if the string name is invalid.

-There is a complete description of the PCRE API in the +There is a complete description of the PCRE native API in the pcreapi +page and a description of the POSIX API in the +pcreposix page. +

+Return to the PCRE index page. +