1 <html> 2 <head> 3 <title>pcre_get_named_substring specification</title> 4 </head> 5 <body bgcolor="#FFFFFF" text="#00005A" link="#0066FF" alink="#3399FF" vlink="#2222BB"> 6 <h1>pcre_get_named_substring man page</h1> 7 <p> 8 Return to the <a href="index.html">PCRE index page</a>. 9 </p> 10 <p> 11 This page is part of the PCRE HTML documentation. It was generated automatically 12 from the original man page. If there is any nonsense in it, please consult the 13 man page, in case the conversion went wrong. 14 <br> 15 <br><b> 16 SYNOPSIS 17 </b><br> 18 <P> 19 <b>#include <pcre.h></b> 20 </P> 21 <P> 22 <b>int pcre_get_named_substring(const pcre *<i>code</i>,</b> 23 <b>const char *<i>subject</i>, int *<i>ovector</i>,</b> 24 <b>int <i>stringcount</i>, const char *<i>stringname</i>,</b> 25 <b>const char **<i>stringptr</i>);</b> 26 </P> 27 <br><b> 28 DESCRIPTION 29 </b><br> 30 <P> 31 This is a convenience function for extracting a captured substring by name. The 32 arguments are: 33 <pre> 34 <i>code</i> Compiled pattern 35 <i>subject</i> Subject that has been successfully matched 36 <i>ovector</i> Offset vector that <b>pcre_exec()</b> used 37 <i>stringcount</i> Value returned by <b>pcre_exec()</b> 38 <i>stringname</i> Name of the required substring 39 <i>stringptr</i> Where to put the string pointer 40 </pre> 41 The memory in which the substring is placed is obtained by calling 42 <b>pcre_malloc()</b>. The convenience function <b>pcre_free_substring()</b> can 43 be used to free it when it is no longer needed. The yield of the function is 44 the length of the extracted substring, PCRE_ERROR_NOMEMORY if sufficient memory 45 could not be obtained, or PCRE_ERROR_NOSUBSTRING if the string name is invalid. 46 </P> 47 <P> 48 There is a complete description of the PCRE native API in the 49 <a href="pcreapi.html"><b>pcreapi</b></a> 50 page and a description of the POSIX API in the 51 <a href="pcreposix.html"><b>pcreposix</b></a> 52 page. 53 <p> 54 Return to the <a href="index.html">PCRE index page</a>. 55 </p> 56
