Debian Codegraph @

doc/SystemTap_Tapset_Reference/man3/function::matched.3stap

raw
1 '\" t
2 .\" Title: function::matched
3 .\" Author:
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\" Date: October 2025
6 .\" Manual: A collection of standard string functions
7 .\" Source: SystemTap Tapset Reference
8 .\" Language: English
9 .\"
10 .TH "FUNCTION::MATCHED" "3stap" "October 2025" "SystemTap Tapset Reference" "A collection of standard strin"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 function::matched \- Return a given matched subexpression\&.
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 matched:string(n:long)
36 .fi
37 .SH "ARGUMENTS"
38 .PP
39 \fIn\fR
40 .RS 4
41 index to the subexpression to return\&. 0 corresponds to the entire regular expression\&.
42 .RE
43 .SH "DESCRIPTION"
44 .PP
45 returns the content of the n\*(Aqth subexpression of the last successful use of the =~ regex matching operator\&. Returns an empty string if the n\*(Aqth subexpression was not matched (e\&.g\&. due to alternation)\&. Throws an error if the last use of =~ was a failed match, or if fewer than n subexpressions are present in the original regexp\&.
46 .SH SEE ALSO\n
47 .IR tapset::regex (3stap)