JCL Help:TJclRegEx.Captures

From Project JEDI Wiki
Jump to navigationJump to search


Summary

Strings resulting from a call to the Match method.


Pascal

 public property Captures [Index: Integer]: string;


Exceptions

EPCREError - Raised when an index value exceeds the number of strings in the captured results.


Description

Captures is a read-only string property that provides access to strings resulting from a call to the Match method. Captures is an indexed property that provides access to each string in the result set by its' ordinal position. Each string in Captures corresponds to a match for metacharacters and character classes specifed in the compiled regular expression.
Use CaptureRanges to access the starting and ending offsets of the Capture string in the text subject.
Use CaptureCount to determine the total number of strings in the result from the Match method. The index values used to access the Captures and CaptureRanges properties is guaranteed to be in the range 0 up to CaptureCount-1.


See Also

CaptureCount CaptureRanges Match EPCREError


About

Notes

The size of the string returned fro the Capture property is limited to 1025 characters (the size of the buffer allocated for string retrieval).


Contribute to this help topic

This documentation wiki is based on the collaborative effort of Project JEDI users. Your edits are welcome in order to improve documentation quality: edit this page