summaryrefslogtreecommitdiffstats
path: root/tapsets/API-kernel-buffer-quoted-error.html
blob: 544c05b2a2a530907577b7184eebf6efce2b48d5 (plain) (blame)
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>function::kernel_buffer_quoted_error</title><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="SystemTap Tapset Reference Manual"><link rel="up" href="conversions.stp.html" title="Chapter 25. String and data retrieving functions Tapset"><link rel="prev" href="API-kernel-buffer-quoted.html" title="function::kernel_buffer_quoted"><link rel="next" href="API-kernel-char.html" title="function::kernel_char"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center"><span class="phrase">function::kernel_buffer_quoted_error</span></th></tr><tr><td width="20%" align="left"><a accesskey="p" href="API-kernel-buffer-quoted.html">Prev</a> </td><th width="60%" align="center">Chapter 25. String and data retrieving functions Tapset</th><td width="20%" align="right"> <a accesskey="n" href="API-kernel-char.html">Next</a></td></tr></table><hr></div><div class="refentry"><a name="API-kernel-buffer-quoted-error"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>function::kernel_buffer_quoted_error — Retrieves and quotes buffer from kernel space </p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="programlisting"> kernel_buffer_quoted_error:string(addr:long,inlen:long,outlen:long) </pre></div><div class="refsect1"><a name="id2231"></a><h2>Arguments</h2><div class="variablelist"><dl class="variablelist"><dt><span class="term"><em class="parameter"><code>addr</code></em></span></dt><dd><p> the kernel space address to retrieve the buffer from </p></dd><dt><span class="term"><em class="parameter"><code>inlen</code></em></span></dt><dd><p> the exact length of the buffer to read </p></dd><dt><span class="term"><em class="parameter"><code>outlen</code></em></span></dt><dd><p> the maximum length of the output string </p></dd></dl></div></div><div class="refsect1"><a name="id2232"></a><h2>Description</h2><p> Reads inlen characters of a buffer from the given kernel 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 kernel space data is not accessible at the given address, an error is thrown. </p></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="API-kernel-buffer-quoted.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="conversions.stp.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="API-kernel-char.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"><span class="phrase">function::kernel_buffer_quoted</span> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> <span class="phrase">function::kernel_char</span></td></tr></table></div></body></html>