1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml">
3  <head>
4    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
5    <meta http-equiv="Content-Style-Type" content="text/css" />
6    <link rel="stylesheet" href="../../../../css/manpage.css" type="text/css" />
7    <title>PutBackTraceString</title>
8  </head>
9  <body>
10    <h1><CODE><a href="../../../../nn/Overview.html">nn</a>::<a href="../../../../nn/dbg/Overview.html">dbg</a>::<a href="../../../../nn/dbg/CTR/Overview.html">CTR</a>::<a href="../../../../nn/dbg/CTR/ExceptionScreen/Overview.html">ExceptionScreen</a>::PutBackTraceString</CODE> Member Function</h1>
11    <h2>Syntax</h2>
12    <div class="section">
13      <pre class="definition">#include &lt;nn/dbg.h&gt;
14
15static <a href="../../../../nn_types/s32.html">s32</a> PutBackTraceString(
16     char * pOut,
17     size_t size,
18     <a href="../../../../nn_types/uptr.html">uptr</a> stackPtr,
19     <a href="../../../../nn_types/bit32.html">bit32</a> lr
20);
21</pre>
22    </div>
23    <h2>Parameters</h2>
24    <div class="section">
25      <table class="arguments">
26        <thead>
27          <tr>
28            <td width="15" />
29            <th>Name</th>
30            <td>Description</td>
31          </tr>
32        </thead>
33        <tr>
34          <td>out</td>
35          <th>pOut</th>
36          <td>The string buffer to output to.</td>
37        </tr>
38        <tr>
39          <td>in</td>
40          <th>size</th>
41          <td>The size of the string buffer.</td>
42        </tr>
43        <tr>
44          <td>in</td>
45          <th>stackPtr</th>
46          <td>Stack pointer value.</td>
47        </tr>
48        <tr>
49          <td>in</td>
50          <th>lr</th>
51          <td>Link register value.</td>
52        </tr> </table>
53    </div>
54    <h2>Return Values</h2>
55    <div class="section">The number of characters written </div>
56    <h2>Description</h2>
57    <div class="section">
58      <p>Generates a back-trace for the current thread.</p><p>Based on the specified information, a set of back-trace information for the current thread is generated as a string and written to the specified buffer.</p><p>This function provides an easy way of parsing stack traces. Note that addresses that are not function calls might be included in the output.</p><p>This function does not need to be called when using <CODE><a href="../../../../nn/dbg/CTR/ExceptionScreen/Overview.html">ExceptionScreen</a></CODE>. It is provided so that the processing implemented internally in <CODE><a href="../../../../nn/dbg/CTR/ExceptionScreen/Overview.html">ExceptionScreen</a></CODE> can be used in other places.</p><!-- write here --></div>
59    <h2>Revision History</h2>
60    <div class="section">
61      <dl class="history">
62        <dt>2012/04/20</dt>
63        <dd>Initial version.<br />
64        </dd>
65      </dl>
66    </div>
67  <hr><p>CONFIDENTIAL</p></body>
68</html>