Debian Codegraph @

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

raw
1 '\" t
2 .\" Title: function::ngroups
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::NGROUPS" "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::ngroups \- Number of subexpressions in the last match\&.
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 ngroups:long()
36 .fi
37 .SH "ARGUMENTS"
38 .PP
39 None
40 .SH "DESCRIPTION"
41 .PP
42 returns the number of subexpressions from the last successful use of the =~ regex matching operator\&.
43 .PP
44 Note that this number includes subexpressions which are present in the regex but did not match any string; for example, given the regex
45 \(lqa|(b)\(rq, the subexpressions will count the group for (b) regardless of whether it matched a string or not\&. Throws an error if the last use of =~ was a failed match\&.
46 .SH SEE ALSO\n
47 .IR tapset::regex (3stap)