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

244 lines
13 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/pxipm.h File Reference</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="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">pxipm.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Process Manager PXI service.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;<a class="el" href="exheader_8h_source.html">3ds/exheader.h</a>&gt;</code><br />
<code>#include &lt;<a class="el" href="fs_8h_source.html">3ds/services/fs.h</a>&gt;</code><br />
</div>
<p><a href="pxipm_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ada0f8c50541c372eb4a2ae9998eb1529"><td class="memItemLeft" align="right" valign="top"><a id="ada0f8c50541c372eb4a2ae9998eb1529"></a>
<a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pxipm_8h.html#ada0f8c50541c372eb4a2ae9998eb1529">pxiPmInit</a> (void)</td></tr>
<tr class="memdesc:ada0f8c50541c372eb4a2ae9998eb1529"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes PxiPM. <br /></td></tr>
<tr class="separator:ada0f8c50541c372eb4a2ae9998eb1529"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a25527bf8f0ce6241f63acc5d9c861881"><td class="memItemLeft" align="right" valign="top"><a id="a25527bf8f0ce6241f63acc5d9c861881"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pxipm_8h.html#a25527bf8f0ce6241f63acc5d9c861881">pxiPmExit</a> (void)</td></tr>
<tr class="memdesc:a25527bf8f0ce6241f63acc5d9c861881"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exits PxiPM. <br /></td></tr>
<tr class="separator:a25527bf8f0ce6241f63acc5d9c861881"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a65cb2e43d7fd2ba24cbf148a32aa997e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pxipm_8h.html#a65cb2e43d7fd2ba24cbf148a32aa997e">pxiPmGetSessionHandle</a> (void)</td></tr>
<tr class="memdesc:a65cb2e43d7fd2ba24cbf148a32aa997e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the current PxiPM session handle. <a href="pxipm_8h.html#a65cb2e43d7fd2ba24cbf148a32aa997e">More...</a><br /></td></tr>
<tr class="separator:a65cb2e43d7fd2ba24cbf148a32aa997e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1c5f1f9b77198fe8118a400962733ce6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pxipm_8h.html#a1c5f1f9b77198fe8118a400962733ce6">PXIPM_GetProgramInfo</a> (<a class="el" href="structExHeader__Info.html">ExHeader_Info</a> *exheaderInfo, <a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> programHandle)</td></tr>
<tr class="memdesc:a1c5f1f9b77198fe8118a400962733ce6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrives the exheader information set(s) (SCI+ACI) about a program. <a href="pxipm_8h.html#a1c5f1f9b77198fe8118a400962733ce6">More...</a><br /></td></tr>
<tr class="separator:a1c5f1f9b77198fe8118a400962733ce6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5fd65a1f8c7b325c28ffec5817ee073b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pxipm_8h.html#a5fd65a1f8c7b325c28ffec5817ee073b">PXIPM_RegisterProgram</a> (<a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> *programHandle, const <a class="el" href="structFS__ProgramInfo.html">FS_ProgramInfo</a> *programInfo, const <a class="el" href="structFS__ProgramInfo.html">FS_ProgramInfo</a> *updateInfo)</td></tr>
<tr class="memdesc:a5fd65a1f8c7b325c28ffec5817ee073b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Loads a program and registers it to Process9. <a href="pxipm_8h.html#a5fd65a1f8c7b325c28ffec5817ee073b">More...</a><br /></td></tr>
<tr class="separator:a5fd65a1f8c7b325c28ffec5817ee073b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4289899e9d75605890ba28416614f004"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pxipm_8h.html#a4289899e9d75605890ba28416614f004">PXIPM_UnregisterProgram</a> (<a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> programHandle)</td></tr>
<tr class="memdesc:a4289899e9d75605890ba28416614f004"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unloads a program and unregisters it from Process9. <a href="pxipm_8h.html#a4289899e9d75605890ba28416614f004">More...</a><br /></td></tr>
<tr class="separator:a4289899e9d75605890ba28416614f004"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Process Manager PXI service. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a1c5f1f9b77198fe8118a400962733ce6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1c5f1f9b77198fe8118a400962733ce6">&#9670;&nbsp;</a></span>PXIPM_GetProgramInfo()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> PXIPM_GetProgramInfo </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structExHeader__Info.html">ExHeader_Info</a> *&#160;</td>
<td class="paramname"><em>exheaderInfo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a>&#160;</td>
<td class="paramname"><em>programHandle</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrives the exheader information set(s) (SCI+ACI) about a program. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">exheaderInfos[out]</td><td>Pointer to the output exheader information set. </td></tr>
<tr><td class="paramname">programHandle</td><td>The program handle. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a5fd65a1f8c7b325c28ffec5817ee073b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5fd65a1f8c7b325c28ffec5817ee073b">&#9670;&nbsp;</a></span>PXIPM_RegisterProgram()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> PXIPM_RegisterProgram </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> *&#160;</td>
<td class="paramname"><em>programHandle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structFS__ProgramInfo.html">FS_ProgramInfo</a> *&#160;</td>
<td class="paramname"><em>programInfo</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structFS__ProgramInfo.html">FS_ProgramInfo</a> *&#160;</td>
<td class="paramname"><em>updateInfo</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Loads a program and registers it to Process9. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">programHandle[out]</td><td>Pointer to the output the program handle to. </td></tr>
<tr><td class="paramname">programInfo</td><td>Information about the program to load. </td></tr>
<tr><td class="paramname">updateInfo</td><td>Information about the program update to load. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a4289899e9d75605890ba28416614f004"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4289899e9d75605890ba28416614f004">&#9670;&nbsp;</a></span>PXIPM_UnregisterProgram()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> PXIPM_UnregisterProgram </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a>&#160;</td>
<td class="paramname"><em>programHandle</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Unloads a program and unregisters it from Process9. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">programHandle</td><td>The program handle. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a65cb2e43d7fd2ba24cbf148a32aa997e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a65cb2e43d7fd2ba24cbf148a32aa997e">&#9670;&nbsp;</a></span>pxiPmGetSessionHandle()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a>* pxiPmGetSessionHandle </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the current PxiPM session handle. </p>
<dl class="section return"><dt>Returns</dt><dd>The current PxiPM session handle. </dd></dl>
</div>
</div>
</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>