GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  PCRE16_GET_NAMED_SUBSTRING (3)

NAME

PCRE - Perl-compatible regular expressions

CONTENTS

Synopsis
Description

SYNOPSIS

#include <pcre.h>


int pcre_get_named_substring(const pcre *code, 

     const char *subject, int *ovector, 

     int stringcount, const char *stringname, 

     const char **stringptr); 

int pcre16_get_named_substring(const pcre16 *code, PCRE_SPTR16 subject, int *ovector, int stringcount, PCRE_SPTR16 stringname, PCRE_SPTR16 *stringptr);

int pcre32_get_named_substring(const pcre32 *code, PCRE_SPTR32 subject, int *ovector, int stringcount, PCRE_SPTR32 stringname, PCRE_SPTR32 *stringptr);

DESCRIPTION

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
ovector Offset vector that pcre[16|32]_exec() used
stringcount Value returned by pcre[16|32]_exec()
stringname Name of the required substring
stringptr Where to put the string pointer

The memory in which the substring is placed is obtained by calling pcre[16|32]_malloc(). The convenience function pcre[16|32]_free_substring() can be used to free it when it is no longer needed. 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 native API in the pcreapi page and a description of the POSIX API in the pcreposix page.

Search for    or go to Top of page |  Section 3 |  Main Index


PCRE 8.30 PCRE_GET_NAMED_SUBSTRING (3) 24 June 2012

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.