--- code/trunk/doc/html/pcre_get_named_substring.html 2007/02/24 21:40:03 63 +++ code/trunk/doc/html/pcre_get_named_substring.html 2007/02/24 21:40:37 75 @@ -3,9 +3,15 @@ pcre_get_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_get_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
@@ -24,8 +30,6 @@

This is a convenience function for extracting a captured substring by name. The arguments are: -

-

   code          Compiled pattern
   subject       Subject that has been successfully matched
@@ -33,14 +37,18 @@
   stringcount   Value returned by pcre_exec()
   stringname    Name of the required substring
   stringptr     Where to put the string pointer
-
-

-

-The yield is the length of the extracted substring, PCRE_ERROR_NOMEMORY if -sufficient memory could not be obtained, or PCRE_ERROR_NOSUBSTRING if the -string name is invalid. + +The memory in which the substring is placed is obtained by calling +pcre_malloc(). The yield of the function is the length of the extracted +substring, PCRE_ERROR_NOMEMORY if sufficient memory could not be obtained, 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. +