Debian Codegraph @

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

raw
1 '\" t
2 .\" Title: function::stringat
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::STRINGAT" "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::stringat \- Returns the char at a given position in the string
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 stringat:long(str:string,pos:long)
36 .fi
37 .SH "ARGUMENTS"
38 .PP
39 \fIstr\fR
40 .RS 4
41 the string to fetch the character from
42 .RE
43 .PP
44 \fIpos\fR
45 .RS 4
46 the position to get the character from (first character is 0)
47 .RE
48 .SH "DESCRIPTION"
49 .PP
50 This function returns the character at a given position in the string or zero if the string doesn\*(Aqt have as many characters\&. Reports an error if pos is out of bounds\&.
51 .SH SEE ALSO\n
52 .IR tapset::string (3stap)