Debian Codegraph @

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

raw
1 '\" t
2 .\" Title: function::user_string_n
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 \- Retrieves string of given length from user space
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 1) user_string_n:string(addr:long,n:long)
36 .fi
37 .sp
38 .nf
39 2) user_string_n:string(addr:long,n:long,err_msg:string)
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 \fIerr_msg\fR
54 .RS 4
55 the error message to return when data isn\*(Aqt available
56 .RE
57 .SH "DESCRIPTION"
58 .PP
59 1) Returns the C string of a maximum given length from a given user space address\&. Reports an error on the rare cases when userspace data is not accessible at the given address\&.
60 .PP
61 2) Returns the C string of a maximum given length from a given user space address\&. Returns the given error message string on the rare cases when userspace data is not accessible at the given address\&.
62 .SH SEE ALSO\n
63 .IR tapset::uconversions (3stap)
64 .SH SEE ALSO\n
65 .IR tapset::uconversions (3stap)