Debian Codegraph @

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

raw
1 '\" t
2 .\" Title: function::user_string_n_quoted
3 .\" Author:
4 .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
5 .\" Date: October 2025
6 .\" Manual: String and data retrieving functions Tapset
7 .\" Source: SystemTap Tapset Reference
8 .\" Language: English
9 .\"
10 .TH "FUNCTION::USER_STRIN" "3stap" "October 2025" "SystemTap Tapset Reference" "String and data retrieving fun"
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::user_string_n_quoted \- Retrieves and quotes string from user space
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 1) user_string_n_quoted:string(addr:long,n:long)
36 .fi
37 .sp
38 .nf
39 2) user_string_n_quoted:string(addr:long,inlen:long,outlen:long)
40 .fi
41 .SH "ARGUMENTS"
42 .PP
43 \fIaddr\fR
44 .RS 4
45 the user space address to retrieve the string from
46 .RE
47 .PP
48 \fIn\fR
49 .RS 4
50 the maximum length of the string (if not null terminated)
51 .RE
52 .PP
53 \fIinlen\fR
54 .RS 4
55 the maximum length of the string to read (if not null terminated)
56 .RE
57 .PP
58 \fIoutlen\fR
59 .RS 4
60 the maximum length of the output string
61 .RE
62 .SH "DESCRIPTION"
63 .PP
64 1) Returns up to n characters of a C string from the given user space memory address where any ASCII characters that are not printable are replaced by the corresponding escape sequence in the returned string\&. Note that the string will be surrounded by double quotes\&. On the rare cases when userspace data is not accessible at the given address, the address itself is returned as a string, without double quotes\&.
65 .PP
66 2) Reads up to inlen characters of a C string from the given user space memory address, and returns up to outlen characters, where any ASCII characters that are not printable are replaced by the corresponding escape sequence in the returned string\&. Note that the string will be surrounded by double quotes\&. On the rare cases when userspace data is not accessible at the given address, the address itself is returned as a string, without double quotes\&.
67 .SH SEE ALSO\n
68 .IR tapset::uconversions (3stap)