mika/libnx
1
0
Fork 0
mirror of https://github.com/switchbrew/libnx.git synced 2025-06-21 20:42:44 +02:00
Code Issues Packages Projects Releases Wiki Activity
gh-pages
libnx/libapplet_8h_source.html
WinterMute bf00061749 Deploying to gh-pages from @ 29f6f4fa7a 🚀
2025-05-08 06:59:12 +00:00

260 lines
43 KiB
HTML
Raw Permalink Blame History

<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libnx: include/switch/applets/libapplet.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 id="projectrow">
<td id="projectalign">
<div id="projectname">libnx<span id="projectnumber">&#160;v4.9.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</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_42bea3d40f1f1694e41a8f3166c98108.html">switch</a></li><li class="navelem"><a class="el" href="dir_68784c92a8a0520ca3b455e73fe4da44.html">applets</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">libapplet.h</div></div>
</div><!--header-->
<div class="contents">
<a href="libapplet_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/**</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * @file libapplet.h</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * @brief LibraryApplet wrapper.</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * @author yellows8</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * @copyright libnx Authors</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> */</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &quot;../types.h&quot;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &quot;../services/applet.h&quot;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include &quot;../services/acc.h&quot;</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"></span> </div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment">/// CommonArguments</span></div>
<div class="foldopen" id="foldopen00013" data-start="{" data-end="};">
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="structLibAppletArgs.html"> 13</a></span><span class="comment"></span><span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"><a class="line" href="structLibAppletArgs.html#ac3665d05b206aabd5d2e59e5a689f5ed"> 14</a></span> <a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> <a class="code hl_variable" href="structLibAppletArgs.html#ac3665d05b206aabd5d2e59e5a689f5ed">CommonArgs_version</a>; <span class="comment">///&lt; \ref libappletArgsCreate sets this to 1, and \ref libappletArgsPop requires value 1. v0 is not supported.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="structLibAppletArgs.html#ab1efc8b73eef705e762a50c0daff25df"> 15</a></span> <a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> <a class="code hl_variable" href="structLibAppletArgs.html#ab1efc8b73eef705e762a50c0daff25df">CommonArgs_size</a>; <span class="comment">///&lt; Size of this struct.</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="structLibAppletArgs.html#a714b5e251bde5acdec15e3899014b59f"> 17</a></span> <a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> <a class="code hl_variable" href="structLibAppletArgs.html#a714b5e251bde5acdec15e3899014b59f">LaVersion</a>; <span class="comment">///&lt; LibraryApplet API version.</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="structLibAppletArgs.html#a9d5294c14ed0e6470a686def94fba2fb"> 18</a></span> <a class="code hl_typedef" href="types_8h.html#ae9b1af5c037e57a98884758875d3a7c4">s32</a> <a class="code hl_variable" href="structLibAppletArgs.html#a9d5294c14ed0e6470a686def94fba2fb">ExpectedThemeColor</a>; <span class="comment">///&lt; Set to the output from \ref appletGetThemeColorType by \ref libappletArgsCreate.</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"><a class="line" href="structLibAppletArgs.html#a68991fefe9f0a11f0a7f38d262b1f4cf"> 19</a></span> <a class="code hl_typedef" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> <a class="code hl_variable" href="structLibAppletArgs.html#a68991fefe9f0a11f0a7f38d262b1f4cf">PlayStartupSound</a>; <span class="comment">///&lt; bool flag, default is false.</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"><a class="line" href="structLibAppletArgs.html#a4adddd0f31b8663e812e29a290231a95"> 20</a></span> <a class="code hl_typedef" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> pad[7]; <span class="comment">///&lt; Padding.</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"><a class="line" href="structLibAppletArgs.html#a7358bcadcd016034a74f35acc5ff0ed8"> 21</a></span> <a class="code hl_typedef" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> <a class="code hl_variable" href="structLibAppletArgs.html#a7358bcadcd016034a74f35acc5ff0ed8">tick</a>; <span class="comment">///&lt; System tick. Set to the output from \ref armGetSystemTick during \ref libappletArgsPush.</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span>} <a class="code hl_struct" href="structLibAppletArgs.html">LibAppletArgs</a>;</div>
</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="comment"></span> </div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="comment">/**</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="comment"> * @brief Creates a LibAppletArgs struct.</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="comment"> * @param a LibAppletArgs struct.</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="comment"> * @param version LaVersion for \ref LibAppletArgs.</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span><span class="comment"> */</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"><a class="line" href="libapplet_8h.html#a3d72ef8b3770fdfffa802ef585e29be9"> 29</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="libapplet_8h.html#a3d72ef8b3770fdfffa802ef585e29be9">libappletArgsCreate</a>(<a class="code hl_struct" href="structLibAppletArgs.html">LibAppletArgs</a>* a, <a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> version);</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="comment"></span> </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="comment">/**</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="comment"> * @brief Sets the PlayStartupSound field in \ref LibAppletArgs.</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span><span class="comment"> * @param a LibAppletArgs struct.</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span><span class="comment"> * @param flag Value for \ref LibAppletArgs PlayStartupSound.</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span><span class="comment"> */</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="libapplet_8h.html#ad917fb9a79685d59570387a389403d54"> 36</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="libapplet_8h.html#ad917fb9a79685d59570387a389403d54">libappletArgsSetPlayStartupSound</a>(<a class="code hl_struct" href="structLibAppletArgs.html">LibAppletArgs</a>* a, <span class="keywordtype">bool</span> flag);</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="comment"></span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="comment">/**</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="comment"> * @brief Creates an AppletStorage with the specified size and writes the buffer contents to that storage at offset 0.</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="comment"> * @param[out] s Storage object.</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="comment"> * @param buffer Input buffer.</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="comment"> * @param size Size to write.</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><span class="comment"> */</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="libapplet_8h.html#af3779143622a35c2146f92f4c2f48fc4"> 44</a></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="libapplet_8h.html#af3779143622a35c2146f92f4c2f48fc4">libappletCreateWriteStorage</a>(<a class="code hl_struct" href="structAppletStorage.html">AppletStorage</a>* s, <span class="keyword">const</span> <span class="keywordtype">void</span>* buffer, <span class="keywordtype">size_t</span> size);</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span><span class="comment"></span> </div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><span class="comment">/**</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="comment"> * @brief Reads data from offset 0 from the specified storage into the buffer. If the storage-size is smaller than the size param, the storage-size is used instead.</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span><span class="comment"> * @param s Storage object.</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="comment"> * @param buffer Output buffer.</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span><span class="comment"> * @param size Size to read.</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span><span class="comment"> * @param transfer_size Optional output size field for the actual size used for the read, can be NULL.</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="comment"> */</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"><a class="line" href="libapplet_8h.html#a5471f4d0a6086ea863c52bcfd97e5276"> 53</a></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="libapplet_8h.html#a5471f4d0a6086ea863c52bcfd97e5276">libappletReadStorage</a>(<a class="code hl_struct" href="structAppletStorage.html">AppletStorage</a>* s, <span class="keywordtype">void</span>* buffer, <span class="keywordtype">size_t</span> size, <span class="keywordtype">size_t</span> *transfer_size);</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span><span class="comment"></span> </div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span><span class="comment">/**</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span><span class="comment"> * @brief Sets the tick field in LibAppletArgs, then creates a storage with it which is pushed to the AppletHolder via \ref appletHolderPushInData.</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span><span class="comment"> * @param a LibAppletArgs struct.</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span><span class="comment"> * @param h AppletHolder object.</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><span class="comment"> */</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"><a class="line" href="libapplet_8h.html#a1ead96255f78fa95e57f265119ad9933"> 60</a></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="libapplet_8h.html#a1ead96255f78fa95e57f265119ad9933">libappletArgsPush</a>(<a class="code hl_struct" href="structLibAppletArgs.html">LibAppletArgs</a>* a, <a class="code hl_struct" href="structAppletHolder.html">AppletHolder</a> *h);</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span><span class="comment"></span> </div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><span class="comment">/**</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span><span class="comment"> * @brief Uses \ref appletPopInData and reads it to the specified LibAppletArgs. The LibAppletArgs is validated, an error is thrown when invalid.</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span><span class="comment"> * @param[out] a LibAppletArgs struct.</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span><span class="comment"> */</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"><a class="line" href="libapplet_8h.html#a610b851d5d4da204e4d1a5e63d6a79b0"> 66</a></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="libapplet_8h.html#a610b851d5d4da204e4d1a5e63d6a79b0">libappletArgsPop</a>(<a class="code hl_struct" href="structLibAppletArgs.html">LibAppletArgs</a>* a);</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span><span class="comment"></span> </div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span><span class="comment">/**</span></div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span><span class="comment"> * @brief Creates a storage using the input buffer which is pushed to the AppletHolder via \ref appletHolderPushInData.</span></div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span><span class="comment"> * @param h AppletHolder object.</span></div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span><span class="comment"> * @param buffer Input data buffer.</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span><span class="comment"> * @param size Input data size.</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span><span class="comment"> */</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"><a class="line" href="libapplet_8h.html#aa39b02a40c4a8e26f914d09b8f142549"> 74</a></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="libapplet_8h.html#aa39b02a40c4a8e26f914d09b8f142549">libappletPushInData</a>(<a class="code hl_struct" href="structAppletHolder.html">AppletHolder</a> *h, <span class="keyword">const</span> <span class="keywordtype">void</span>* buffer, <span class="keywordtype">size_t</span> size);</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span><span class="comment"></span> </div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span><span class="comment">/**</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span><span class="comment"> * @brief Pops a storage via \ref appletHolderPopOutData, uses \ref libappletReadStorage, then closes the storage. </span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"> 78</span><span class="comment"> * @param h AppletHolder object.</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span><span class="comment"> * @param buffer Output buffer.</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span><span class="comment"> * @param size Size to read.</span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span><span class="comment"> * @param transfer_size Optional output size field for the actual size used for the read, can be NULL.</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span><span class="comment"> */</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"><a class="line" href="libapplet_8h.html#a5320c612d3a0c17246842107c84c8b61"> 83</a></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="libapplet_8h.html#a5320c612d3a0c17246842107c84c8b61">libappletPopOutData</a>(<a class="code hl_struct" href="structAppletHolder.html">AppletHolder</a> *h, <span class="keywordtype">void</span>* buffer, <span class="keywordtype">size_t</span> size, <span class="keywordtype">size_t</span> *transfer_size);</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span><span class="comment"></span> </div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span><span class="comment">/**</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span><span class="comment"> * @brief Sets whether \ref libappletStart uses \ref appletHolderJump.</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span><span class="comment"> * @param flag Flag. Value true should not be used unless running as AppletType_LibraryApplet.</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span><span class="comment"> */</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"><a class="line" href="libapplet_8h.html#a6f983f71cd67ad9753e43a8ad8aeb899"> 89</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="libapplet_8h.html#a6f983f71cd67ad9753e43a8ad8aeb899">libappletSetJumpFlag</a>(<span class="keywordtype">bool</span> flag);</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span><span class="comment"></span> </div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span><span class="comment">/**</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span><span class="comment"> * @brief If the flag from \ref libappletSetJumpFlag is set, this just uses \ref appletHolderJump. Otherwise, starts the applet and waits for it to finish, then checks the \ref LibAppletExitReason.</span></div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span><span class="comment"> * @note Uses \ref appletHolderStart and \ref appletHolderJoin.</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span><span class="comment"> * @param h AppletHolder object.</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span><span class="comment"> */</span></div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"><a class="line" href="libapplet_8h.html#a35af19841a4970672d0e16552915a9d7"> 96</a></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="libapplet_8h.html#a35af19841a4970672d0e16552915a9d7">libappletStart</a>(<a class="code hl_struct" href="structAppletHolder.html">AppletHolder</a> *h);</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"> 97</span><span class="comment"></span> </div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span><span class="comment">/**</span></div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span><span class="comment"> * @brief Creates a LibraryApplet with the specified input storage data, uses \ref libappletStart, and reads the output storage reply data via \ref libappletPopOutData.</span></div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span><span class="comment"> * @param id \ref AppletId</span></div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span><span class="comment"> * @param commonargs \ref LibAppletArgs struct.</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span><span class="comment"> * @param arg Input storage data buffer. Optional, can be NULL.</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span><span class="comment"> * @param arg_size Size of the arg buffer.</span></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span><span class="comment"> * @param reply Output storage data buffer. Optional, can be NULL.</span></div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span><span class="comment"> * @param reply_size Size to read for the reply buffer.</span></div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"> 106</span><span class="comment"> * @param out_reply_size Actual read reply data size, see \ref libappletPopOutData.</span></div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span><span class="comment"> */</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"><a class="line" href="libapplet_8h.html#af3f2d6342f1ac95f140aead450f5c8ba"> 108</a></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="libapplet_8h.html#af3f2d6342f1ac95f140aead450f5c8ba">libappletLaunch</a>(<a class="code hl_enumeration" href="applet_8h.html#ad14dd5237407f4896cf69bb53362b346">AppletId</a> <span class="keywordtype">id</span>, <a class="code hl_struct" href="structLibAppletArgs.html">LibAppletArgs</a> *commonargs, <span class="keyword">const</span> <span class="keywordtype">void</span>* arg, <span class="keywordtype">size_t</span> arg_size, <span class="keywordtype">void</span>* reply, <span class="keywordtype">size_t</span> reply_size, <span class="keywordtype">size_t</span> *out_reply_size);</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span><span class="comment"></span> </div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span><span class="comment">/// Wrapper for \ref appletPushToGeneralChannel, see appletPushToGeneralChannel regarding the requirements for using this.</span></div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span><span class="comment">/// Returns to the main Home Menu, equivalent to pressing the HOME button.</span></div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"><a class="line" href="libapplet_8h.html#a6c0ca1a2039f9deb5fdcfb43aa746489"> 112</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="libapplet_8h.html#a6c0ca1a2039f9deb5fdcfb43aa746489">libappletRequestHomeMenu</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span><span class="comment"></span> </div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"> 114</span><span class="comment">/// Wrapper for \ref appletPushToGeneralChannel, see appletPushToGeneralChannel regarding the requirements for using this.</span></div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span><span class="comment">/// Equivalent to entering &quot;System Update&quot; under System Settings. When leaving this, it returns to the main Home Menu.</span></div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"><a class="line" href="libapplet_8h.html#abe7eb7d082fc0a0933261111301bf261"> 116</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="libapplet_8h.html#abe7eb7d082fc0a0933261111301bf261">libappletRequestJumpToSystemUpdate</a>(<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span><span class="comment"></span> </div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span><span class="comment">/**</span></div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span><span class="comment"> * @brief Wrapper for \ref appletPushToGeneralChannel, see appletPushToGeneralChannel regarding the requirements for using this.</span></div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span><span class="comment"> * @note Only available on [11.0.0+].</span></div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span><span class="comment"> * @param[in] application_id ApplicationId</span></div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span><span class="comment"> * @param[in] uid \ref AccountUid</span></div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span><span class="comment"> * @param[in] buffer Input buffer.</span></div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span><span class="comment"> * @param[in] size Input buffer size.</span></div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span><span class="comment"> * @param[in] sender LaunchApplicationRequestSender</span></div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span><span class="comment"> */</span></div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"><a class="line" href="libapplet_8h.html#afea9e7036964738455d07f367a840d84"> 127</a></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="libapplet_8h.html#afea9e7036964738455d07f367a840d84">libappletRequestToLaunchApplication</a>(<a class="code hl_typedef" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> application_id, <a class="code hl_struct" href="structAccountUid.html">AccountUid</a> uid, <span class="keyword">const</span> <span class="keywordtype">void</span>* buffer, <span class="keywordtype">size_t</span> size, <a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> sender);</div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span><span class="comment"></span> </div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span><span class="comment">/**</span></div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span><span class="comment"> * @brief Wrapper for \ref appletPushToGeneralChannel, see appletPushToGeneralChannel regarding the requirements for using this.</span></div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span><span class="comment"> * @note Only available on [11.0.0+].</span></div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span><span class="comment"> * @param[in] uid \ref AccountUid</span></div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"> 133</span><span class="comment"> * @param[in] application_id Optional ApplicationId, can be 0.</span></div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span><span class="comment"> */</span></div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"><a class="line" href="libapplet_8h.html#a46fd963a26b70d91848adfb8cefe785b"> 135</a></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="libapplet_8h.html#a46fd963a26b70d91848adfb8cefe785b">libappletRequestJumpToStory</a>(<a class="code hl_struct" href="structAccountUid.html">AccountUid</a> uid, <a class="code hl_typedef" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> application_id);</div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span> </div>
<div class="ttc" id="aapplet_8h_html_ad14dd5237407f4896cf69bb53362b346"><div class="ttname"><a href="applet_8h.html#ad14dd5237407f4896cf69bb53362b346">AppletId</a></div><div class="ttdeci">AppletId</div><div class="ttdoc">AppletId.</div><div class="ttdef"><b>Definition</b> applet.h:91</div></div>
<div class="ttc" id="alibapplet_8h_html_a1ead96255f78fa95e57f265119ad9933"><div class="ttname"><a href="libapplet_8h.html#a1ead96255f78fa95e57f265119ad9933">libappletArgsPush</a></div><div class="ttdeci">Result libappletArgsPush(LibAppletArgs *a, AppletHolder *h)</div><div class="ttdoc">Sets the tick field in LibAppletArgs, then creates a storage with it which is pushed to the AppletHol...</div></div>
<div class="ttc" id="alibapplet_8h_html_a35af19841a4970672d0e16552915a9d7"><div class="ttname"><a href="libapplet_8h.html#a35af19841a4970672d0e16552915a9d7">libappletStart</a></div><div class="ttdeci">Result libappletStart(AppletHolder *h)</div><div class="ttdoc">If the flag from libappletSetJumpFlag is set, this just uses appletHolderJump.</div></div>
<div class="ttc" id="alibapplet_8h_html_a3d72ef8b3770fdfffa802ef585e29be9"><div class="ttname"><a href="libapplet_8h.html#a3d72ef8b3770fdfffa802ef585e29be9">libappletArgsCreate</a></div><div class="ttdeci">void libappletArgsCreate(LibAppletArgs *a, u32 version)</div><div class="ttdoc">Creates a LibAppletArgs struct.</div></div>
<div class="ttc" id="alibapplet_8h_html_a46fd963a26b70d91848adfb8cefe785b"><div class="ttname"><a href="libapplet_8h.html#a46fd963a26b70d91848adfb8cefe785b">libappletRequestJumpToStory</a></div><div class="ttdeci">Result libappletRequestJumpToStory(AccountUid uid, u64 application_id)</div><div class="ttdoc">Wrapper for appletPushToGeneralChannel, see appletPushToGeneralChannel regarding the requirements for...</div></div>
<div class="ttc" id="alibapplet_8h_html_a5320c612d3a0c17246842107c84c8b61"><div class="ttname"><a href="libapplet_8h.html#a5320c612d3a0c17246842107c84c8b61">libappletPopOutData</a></div><div class="ttdeci">Result libappletPopOutData(AppletHolder *h, void *buffer, size_t size, size_t *transfer_size)</div><div class="ttdoc">Pops a storage via appletHolderPopOutData, uses libappletReadStorage, then closes the storage.</div></div>
<div class="ttc" id="alibapplet_8h_html_a5471f4d0a6086ea863c52bcfd97e5276"><div class="ttname"><a href="libapplet_8h.html#a5471f4d0a6086ea863c52bcfd97e5276">libappletReadStorage</a></div><div class="ttdeci">Result libappletReadStorage(AppletStorage *s, void *buffer, size_t size, size_t *transfer_size)</div><div class="ttdoc">Reads data from offset 0 from the specified storage into the buffer.</div></div>
<div class="ttc" id="alibapplet_8h_html_a610b851d5d4da204e4d1a5e63d6a79b0"><div class="ttname"><a href="libapplet_8h.html#a610b851d5d4da204e4d1a5e63d6a79b0">libappletArgsPop</a></div><div class="ttdeci">Result libappletArgsPop(LibAppletArgs *a)</div><div class="ttdoc">Uses appletPopInData and reads it to the specified LibAppletArgs.</div></div>
<div class="ttc" id="alibapplet_8h_html_a6c0ca1a2039f9deb5fdcfb43aa746489"><div class="ttname"><a href="libapplet_8h.html#a6c0ca1a2039f9deb5fdcfb43aa746489">libappletRequestHomeMenu</a></div><div class="ttdeci">Result libappletRequestHomeMenu(void)</div><div class="ttdoc">Wrapper for appletPushToGeneralChannel, see appletPushToGeneralChannel regarding the requirements for...</div></div>
<div class="ttc" id="alibapplet_8h_html_a6f983f71cd67ad9753e43a8ad8aeb899"><div class="ttname"><a href="libapplet_8h.html#a6f983f71cd67ad9753e43a8ad8aeb899">libappletSetJumpFlag</a></div><div class="ttdeci">void libappletSetJumpFlag(bool flag)</div><div class="ttdoc">Sets whether libappletStart uses appletHolderJump.</div></div>
<div class="ttc" id="alibapplet_8h_html_aa39b02a40c4a8e26f914d09b8f142549"><div class="ttname"><a href="libapplet_8h.html#aa39b02a40c4a8e26f914d09b8f142549">libappletPushInData</a></div><div class="ttdeci">Result libappletPushInData(AppletHolder *h, const void *buffer, size_t size)</div><div class="ttdoc">Creates a storage using the input buffer which is pushed to the AppletHolder via appletHolderPushInDa...</div></div>
<div class="ttc" id="alibapplet_8h_html_abe7eb7d082fc0a0933261111301bf261"><div class="ttname"><a href="libapplet_8h.html#abe7eb7d082fc0a0933261111301bf261">libappletRequestJumpToSystemUpdate</a></div><div class="ttdeci">Result libappletRequestJumpToSystemUpdate(void)</div><div class="ttdoc">Wrapper for appletPushToGeneralChannel, see appletPushToGeneralChannel regarding the requirements for...</div></div>
<div class="ttc" id="alibapplet_8h_html_ad917fb9a79685d59570387a389403d54"><div class="ttname"><a href="libapplet_8h.html#ad917fb9a79685d59570387a389403d54">libappletArgsSetPlayStartupSound</a></div><div class="ttdeci">void libappletArgsSetPlayStartupSound(LibAppletArgs *a, bool flag)</div><div class="ttdoc">Sets the PlayStartupSound field in LibAppletArgs.</div></div>
<div class="ttc" id="alibapplet_8h_html_af3779143622a35c2146f92f4c2f48fc4"><div class="ttname"><a href="libapplet_8h.html#af3779143622a35c2146f92f4c2f48fc4">libappletCreateWriteStorage</a></div><div class="ttdeci">Result libappletCreateWriteStorage(AppletStorage *s, const void *buffer, size_t size)</div><div class="ttdoc">Creates an AppletStorage with the specified size and writes the buffer contents to that storage at of...</div></div>
<div class="ttc" id="alibapplet_8h_html_af3f2d6342f1ac95f140aead450f5c8ba"><div class="ttname"><a href="libapplet_8h.html#af3f2d6342f1ac95f140aead450f5c8ba">libappletLaunch</a></div><div class="ttdeci">Result libappletLaunch(AppletId id, LibAppletArgs *commonargs, const void *arg, size_t arg_size, void *reply, size_t reply_size, size_t *out_reply_size)</div><div class="ttdoc">Creates a LibraryApplet with the specified input storage data, uses libappletStart,...</div></div>
<div class="ttc" id="alibapplet_8h_html_afea9e7036964738455d07f367a840d84"><div class="ttname"><a href="libapplet_8h.html#afea9e7036964738455d07f367a840d84">libappletRequestToLaunchApplication</a></div><div class="ttdeci">Result libappletRequestToLaunchApplication(u64 application_id, AccountUid uid, const void *buffer, size_t size, u32 sender)</div><div class="ttdoc">Wrapper for appletPushToGeneralChannel, see appletPushToGeneralChannel regarding the requirements for...</div></div>
<div class="ttc" id="astructAccountUid_html"><div class="ttname"><a href="structAccountUid.html">AccountUid</a></div><div class="ttdoc">Account UserId.</div><div class="ttdef"><b>Definition</b> acc.h:25</div></div>
<div class="ttc" id="astructAppletHolder_html"><div class="ttname"><a href="structAppletHolder.html">AppletHolder</a></div><div class="ttdoc">LibraryApplet state.</div><div class="ttdef"><b>Definition</b> applet.h:241</div></div>
<div class="ttc" id="astructAppletStorage_html"><div class="ttname"><a href="structAppletStorage.html">AppletStorage</a></div><div class="ttdoc">applet IStorage</div><div class="ttdef"><b>Definition</b> applet.h:235</div></div>
<div class="ttc" id="astructLibAppletArgs_html"><div class="ttname"><a href="structLibAppletArgs.html">LibAppletArgs</a></div><div class="ttdoc">CommonArguments.</div><div class="ttdef"><b>Definition</b> libapplet.h:13</div></div>
<div class="ttc" id="astructLibAppletArgs_html_a68991fefe9f0a11f0a7f38d262b1f4cf"><div class="ttname"><a href="structLibAppletArgs.html#a68991fefe9f0a11f0a7f38d262b1f4cf">LibAppletArgs::PlayStartupSound</a></div><div class="ttdeci">u8 PlayStartupSound</div><div class="ttdoc">bool flag, default is false.</div><div class="ttdef"><b>Definition</b> libapplet.h:19</div></div>
<div class="ttc" id="astructLibAppletArgs_html_a714b5e251bde5acdec15e3899014b59f"><div class="ttname"><a href="structLibAppletArgs.html#a714b5e251bde5acdec15e3899014b59f">LibAppletArgs::LaVersion</a></div><div class="ttdeci">u32 LaVersion</div><div class="ttdoc">LibraryApplet API version.</div><div class="ttdef"><b>Definition</b> libapplet.h:17</div></div>
<div class="ttc" id="astructLibAppletArgs_html_a7358bcadcd016034a74f35acc5ff0ed8"><div class="ttname"><a href="structLibAppletArgs.html#a7358bcadcd016034a74f35acc5ff0ed8">LibAppletArgs::tick</a></div><div class="ttdeci">u64 tick</div><div class="ttdoc">System tick. Set to the output from armGetSystemTick during libappletArgsPush.</div><div class="ttdef"><b>Definition</b> libapplet.h:21</div></div>
<div class="ttc" id="astructLibAppletArgs_html_a9d5294c14ed0e6470a686def94fba2fb"><div class="ttname"><a href="structLibAppletArgs.html#a9d5294c14ed0e6470a686def94fba2fb">LibAppletArgs::ExpectedThemeColor</a></div><div class="ttdeci">s32 ExpectedThemeColor</div><div class="ttdoc">Set to the output from appletGetThemeColorType by libappletArgsCreate.</div><div class="ttdef"><b>Definition</b> libapplet.h:18</div></div>
<div class="ttc" id="astructLibAppletArgs_html_ab1efc8b73eef705e762a50c0daff25df"><div class="ttname"><a href="structLibAppletArgs.html#ab1efc8b73eef705e762a50c0daff25df">LibAppletArgs::CommonArgs_size</a></div><div class="ttdeci">u32 CommonArgs_size</div><div class="ttdoc">Size of this struct.</div><div class="ttdef"><b>Definition</b> libapplet.h:15</div></div>
<div class="ttc" id="astructLibAppletArgs_html_ac3665d05b206aabd5d2e59e5a689f5ed"><div class="ttname"><a href="structLibAppletArgs.html#ac3665d05b206aabd5d2e59e5a689f5ed">LibAppletArgs::CommonArgs_version</a></div><div class="ttdeci">u32 CommonArgs_version</div><div class="ttdoc">libappletArgsCreate sets this to 1, and libappletArgsPop requires value 1. v0 is not supported.</div><div class="ttdef"><b>Definition</b> libapplet.h:14</div></div>
<div class="ttc" id="atypes_8h_html_a3f7e2bcbb0b4c338f3c4f6c937cd4234"><div class="ttname"><a href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a></div><div class="ttdeci">uint64_t u64</div><div class="ttdoc">64-bit unsigned integer.</div><div class="ttdef"><b>Definition</b> types.h:22</div></div>
<div class="ttc" id="atypes_8h_html_a92c50087ca0e64fa93fc59402c55f8ca"><div class="ttname"><a href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a></div><div class="ttdeci">uint8_t u8</div><div class="ttdoc">8-bit unsigned integer.</div><div class="ttdef"><b>Definition</b> types.h:19</div></div>
<div class="ttc" id="atypes_8h_html_ad1be2721625a17f1be47fac918032afe"><div class="ttname"><a href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a></div><div class="ttdeci">u32 Result</div><div class="ttdoc">Function error code result type.</div><div class="ttdef"><b>Definition</b> types.h:44</div></div>
<div class="ttc" id="atypes_8h_html_ae9b1af5c037e57a98884758875d3a7c4"><div class="ttname"><a href="types_8h.html#ae9b1af5c037e57a98884758875d3a7c4">s32</a></div><div class="ttdeci">int32_t s32</div><div class="ttdoc">32-bit signed integer.</div><div class="ttdef"><b>Definition</b> types.h:27</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:21</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.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink