libctru/pmdbg_8h_source.html
2024-11-03 20:36:34 +00:00

132 lines
14 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libctru: include/3ds/services/pmdbg.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">libctru
&#160;<span id="projectnumber">v2.4.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_d475325f6a9fe3bfc3a495c72a9e475e.html">3ds</a></li><li class="navelem"><a class="el" href="dir_0e005207343684f6967052d1f51a7e66.html">services</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">pmdbg.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="pmdbg_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment"> * @file pmdbg.h</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment"> * @brief PM (Process Manager) debug service.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160; </div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="preprocessor">#include &lt;<a class="code" href="pmapp_8h.html">3ds/services/pmapp.h</a>&gt;</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">/// Initializes pm:dbg.</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"><a class="line" href="pmdbg_8h.html#abd84c269cdf485ebf6131006e08ca4bb"> 10</a></span>&#160;<span class="comment"></span><a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="pmdbg_8h.html#abd84c269cdf485ebf6131006e08ca4bb">pmDbgInit</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">/// Exits pm:dbg.</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"><a class="line" href="pmdbg_8h.html#ad7facb4946d66039f1157fcc5a574d94"> 13</a></span>&#160;<span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="pmdbg_8h.html#ad7facb4946d66039f1157fcc5a574d94">pmDbgExit</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> * @brief Gets the current pm:dbg session handle.</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment"> * @return The current pm:dbg session handle.</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="pmdbg_8h.html#a762f853ca5f1bc8bb34a32638fc5ba9b"> 19</a></span>&#160;<a class="code" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> *<a class="code" href="pmdbg_8h.html#a762f853ca5f1bc8bb34a32638fc5ba9b">pmDbgGetSessionHandle</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="comment"> * @brief Enqueues an application for debug after setting cpuTime to 0, and returns a debug handle to it.</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="comment"> * If another process was enqueued, this just calls @ref RunQueuedProcess instead.</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="comment"> * @param[out] Pointer to output the debug handle to.</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="comment"> * @param programInfo Program information of the title.</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="comment"> * @param launchFlags Flags to launch the title with.</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="pmdbg_8h.html#ad219d5ea114523358ea87f8927ce3cb4"> 28</a></span>&#160;<a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="pmdbg_8h.html#ad219d5ea114523358ea87f8927ce3cb4">PMDBG_LaunchAppDebug</a>(<a class="code" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> *outDebug, <span class="keyword">const</span> <a class="code" href="structFS__ProgramInfo.html">FS_ProgramInfo</a> *programInfo, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> launchFlags);</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="comment"> * @brief Launches an application for debug after setting cpuTime to 0.</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="comment"> * @param programInfo Program information of the title.</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="comment"> * @param launchFlags Flags to launch the title with.</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="pmdbg_8h.html#a75164c1db1a884b44f5c9c8e28e64da1"> 35</a></span>&#160;<a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="pmdbg_8h.html#a75164c1db1a884b44f5c9c8e28e64da1">PMDBG_LaunchApp</a>(<span class="keyword">const</span> <a class="code" href="structFS__ProgramInfo.html">FS_ProgramInfo</a> *programInfo, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> launchFlags);</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="comment"></span> </div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="comment"> * @brief Runs the queued process and returns a debug handle to it.</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="comment"> * @param[out] Pointer to output the debug handle to.</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"><a class="line" href="pmdbg_8h.html#a9f1f44b9e9dbf73836dec8fb4742c33d"> 41</a></span>&#160;<a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="pmdbg_8h.html#a9f1f44b9e9dbf73836dec8fb4742c33d">PMDBG_RunQueuedProcess</a>(<a class="code" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> *outDebug);</div>
<div class="ttc" id="apmapp_8h_html"><div class="ttname"><a href="pmapp_8h.html">pmapp.h</a></div><div class="ttdoc">PM (Process Manager) application service.</div></div>
<div class="ttc" id="apmdbg_8h_html_a75164c1db1a884b44f5c9c8e28e64da1"><div class="ttname"><a href="pmdbg_8h.html#a75164c1db1a884b44f5c9c8e28e64da1">PMDBG_LaunchApp</a></div><div class="ttdeci">Result PMDBG_LaunchApp(const FS_ProgramInfo *programInfo, u32 launchFlags)</div><div class="ttdoc">Launches an application for debug after setting cpuTime to 0.</div></div>
<div class="ttc" id="apmdbg_8h_html_a762f853ca5f1bc8bb34a32638fc5ba9b"><div class="ttname"><a href="pmdbg_8h.html#a762f853ca5f1bc8bb34a32638fc5ba9b">pmDbgGetSessionHandle</a></div><div class="ttdeci">Handle * pmDbgGetSessionHandle(void)</div><div class="ttdoc">Gets the current pm:dbg session handle.</div></div>
<div class="ttc" id="apmdbg_8h_html_a9f1f44b9e9dbf73836dec8fb4742c33d"><div class="ttname"><a href="pmdbg_8h.html#a9f1f44b9e9dbf73836dec8fb4742c33d">PMDBG_RunQueuedProcess</a></div><div class="ttdeci">Result PMDBG_RunQueuedProcess(Handle *outDebug)</div><div class="ttdoc">Runs the queued process and returns a debug handle to it.</div></div>
<div class="ttc" id="apmdbg_8h_html_abd84c269cdf485ebf6131006e08ca4bb"><div class="ttname"><a href="pmdbg_8h.html#abd84c269cdf485ebf6131006e08ca4bb">pmDbgInit</a></div><div class="ttdeci">Result pmDbgInit(void)</div><div class="ttdoc">Initializes pm:dbg.</div></div>
<div class="ttc" id="apmdbg_8h_html_ad219d5ea114523358ea87f8927ce3cb4"><div class="ttname"><a href="pmdbg_8h.html#ad219d5ea114523358ea87f8927ce3cb4">PMDBG_LaunchAppDebug</a></div><div class="ttdeci">Result PMDBG_LaunchAppDebug(Handle *outDebug, const FS_ProgramInfo *programInfo, u32 launchFlags)</div><div class="ttdoc">Enqueues an application for debug after setting cpuTime to 0, and returns a debug handle to it.</div></div>
<div class="ttc" id="apmdbg_8h_html_ad7facb4946d66039f1157fcc5a574d94"><div class="ttname"><a href="pmdbg_8h.html#ad7facb4946d66039f1157fcc5a574d94">pmDbgExit</a></div><div class="ttdeci">void pmDbgExit(void)</div><div class="ttdoc">Exits pm:dbg.</div></div>
<div class="ttc" id="astructFS__ProgramInfo_html"><div class="ttname"><a href="structFS__ProgramInfo.html">FS_ProgramInfo</a></div><div class="ttdoc">Program information.</div><div class="ttdef"><b>Definition:</b> fs.h:183</div></div>
<div class="ttc" id="atypes_8h_html_ab6d744c6b5de129f12937e482dc674fb"><div class="ttname"><a href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a></div><div class="ttdeci">u32 Handle</div><div class="ttdoc">Resource handle.</div><div class="ttdef"><b>Definition:</b> types.h:41</div></div>
<div class="ttc" id="atypes_8h_html_ac830bf5a4f2cf8273f61ab99a46cf163"><div class="ttname"><a href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a></div><div class="ttdeci">s32 Result</div><div class="ttdoc">Function result.</div><div class="ttdef"><b>Definition:</b> types.h:42</div></div>
<div class="ttc" id="atypes_8h_html_afaa62991928fb9fb18ff0db62a040aba"><div class="ttname"><a href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a></div><div class="ttdeci">uint32_t u32</div><div class="ttdoc">32-bit unsigned integer</div><div class="ttdef"><b>Definition:</b> types.h:23</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
</small></address>
</body>
</html>