Debian Codegraph @

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

raw
1 '\" t
2 .\" Title: function::substr
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::SUBSTR" "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::substr \- Returns a substring
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 substr:string(str:string,start:long,length:long)
36 .fi
37 .SH "ARGUMENTS"
38 .PP
39 \fIstr\fR
40 .RS 4
41 the string to take a substring from
42 .RE
43 .PP
44 \fIstart\fR
45 .RS 4
46 starting position of the extracted string (first character is 0)
47 .RE
48 .PP
49 \fIlength\fR
50 .RS 4
51 length of string to return
52 .RE
53 .SH "DESCRIPTION"
54 .PP
55 Returns the substring of the given string at the given start position with the given length (or smaller if the length of the original string is less than start + length, or length is bigger than MAXSTRINGLEN)\&.
56 .SH SEE ALSO\n
57 .IR tapset::string (3stap)