virtual P6R::P6ERR P6R::p6IRegex::getCaptureText ( P6UINT32  index,
P6UINT32 *  pOffset,
P6UINT32 *  pLength 
) [pure virtual]

Return the text by the 1st, 2nd, 3rd, etc.

set of capturing parentheses. Essentially, this method returns the value of a back reference. This is done by returning the starting byte offset into the original input string to the match, search, or replace methods, and the length of the captured text. The caller can then use this information to index their buffer to extract out the actual text.

Parameters:
index [IN] The number of the capturing parenthese (or back reference), starts at 1.
pOffset [OUT] Index into input string buffer (i.e., pSearch or pMatch) used in calls to the 'match','search' or 'replace' methods
pLength [OUT] Length of the matching substring in the input string buffer (i.e., pSearch of pMatch)
Returns:
SuccessP6R::eOk 
FailureP6R::eNotInitializedA successful call to initialize was not made before this call.
P6R::eInvalidArgpOffset or pLength is NULL, or pTextSize value is zero.
P6R::eAccessFaultThe 'match','search', or 'replace' method must be successfully called before this function.
P6R::eMatchEmptyThe index back reference is the empty string.
P6R::eNotFoundThe index back reference does not exist.
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Defines
Copyright © 2004 - 2010 P6R Inc. - All Rights Reserved.