man7.org > Linux > man-pages

Linux/UNIX system programming training

function::user_string_n_quoted(3stap) — Linux manual page

NAME | SYNOPSIS | ARGUMENTS | DESCRIPTION | SEE ALSO | COLOPHON 

FUNCT...STRIN(3stap) String and data retrieving fun FUNCT...STRIN(3stap)

NAME         top

       function::user_string_n_quoted - Retrieves and quotes string from
       user space

SYNOPSIS         top

       1) user_string_n_quoted:string(addr:long,n:long)

       2) user_string_n_quoted:string(addr:long,inlen:long,outlen:long)

ARGUMENTS         top

       addr
           the user space address to retrieve the string from

       n
           the maximum length of the string (if not null terminated)

       inlen
           the maximum length of the string to read (if not null
           terminated)

       outlen
           the maximum length of the output string

DESCRIPTION         top

       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.

       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.

SEE ALSO         top

       tapset::uconversions(3stap)

COLOPHON         top

       This page is part of the systemtap (a tracing and live-system
       analysis tool) project.  Information about the project can be
       found at ⟨https://sourceware.org/systemtap/⟩.  If you have a bug
       report for this manual page, send it to systemtap@sourceware.org.
       This page was obtained from the project's upstream Git repository
       ⟨git://sourceware.org/git/systemtap.git⟩ on 2024-06-14.  (At that
       time, the date of the most recent commit that was found in the
       repository was 2024-06-13.)  If you discover any rendering
       problems in this HTML version of the page, or you believe there
       is a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to
       man-pages@man7.org

SystemTap Tapset Reference     April 2024           FUNCT...STRIN(3stap)

Pages that refer to this page: tapset::uconversions(3stap)

HTML rendering created 2024-06-26 by Michael Kerrisk, author of The Linux Programming Interface.

For details of in-depth Linux/UNIX system programming training courses that I teach, look here.

Hosting by jambit GmbH.

Cover of TLPI