Debian Codegraph @

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

raw
1 '\" t
2 .\" Title: function::return_str
3 .\" Author:
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\" Date: October 2025
6 .\" Manual: Errno Tapset
7 .\" Source: SystemTap Tapset Reference
8 .\" Language: English
9 .\"
10 .TH "FUNCTION::RETURN_STR" "3stap" "October 2025" "SystemTap Tapset Reference" "Errno Tapset"
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::return_str \- Formats the return value as a string
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 return_str:string(format:long,ret:long)
36 .fi
37 .SH "ARGUMENTS"
38 .PP
39 \fIformat\fR
40 .RS 4
41 Variable to determine return type base value
42 .RE
43 .PP
44 \fIret\fR
45 .RS 4
46 Return value (typically
47 \fB$return\fR)
48 .RE
49 .SH "DESCRIPTION"
50 .PP
51 This function is used by the syscall tapset, and returns a string\&. Set format equal to 1 for a decimal, 2 for hex, 3 for octal\&.
52 .PP
53 Note that this function is preferred over
54 \fBreturnstr\fR\&.
55 .SH SEE ALSO\n
56 .IR tapset::errno (3stap)