DevKit7/libctru
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
gh-pages
libctru/env_8h.html
WinterMute e52f3175e1 Deploying to gh-pages from @ 8cbcce773b 🚀
2024-11-03 20:36:34 +00:00

355 lines
17 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">
<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/env.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> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">env.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Homebrew environment information.
<a href="#details">More...</a></p>
<p><a href="env_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="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a726ca809ffd3d67ab4b8476646f26635"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom">{ <br />
&#160;&#160;<a class="el" href="env_8h.html#a726ca809ffd3d67ab4b8476646f26635ad5366df45cecac4dad1f375eaa0555ab">RUNFLAG_APTWORKAROUND</a> = BIT(0)
, <br />
&#160;&#160;<a class="el" href="env_8h.html#a726ca809ffd3d67ab4b8476646f26635a426e94cb64bcd44449b1a13d3a977df8">RUNFLAG_APTREINIT</a> = BIT(1)
, <br />
&#160;&#160;<a class="el" href="env_8h.html#a726ca809ffd3d67ab4b8476646f26635a5eedd97be189872a5f91a561fbe33c88">RUNFLAG_APTCHAINLOAD</a> = BIT(2)
<br />
}</td></tr>
<tr class="memdesc:a726ca809ffd3d67ab4b8476646f26635"><td class="mdescLeft">&#160;</td><td class="mdescRight">System run-flags. <a href="env_8h.html#a726ca809ffd3d67ab4b8476646f26635">More...</a><br /></td></tr>
<tr class="separator:a726ca809ffd3d67ab4b8476646f26635"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a50c57dd1aacb61a98605a295d3789f11"><td class="memItemLeft" align="right" valign="top">static bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="env_8h.html#a50c57dd1aacb61a98605a295d3789f11">envIsHomebrew</a> (void)</td></tr>
<tr class="memdesc:a50c57dd1aacb61a98605a295d3789f11"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets whether the application was launched from a homebrew environment. <a href="env_8h.html#a50c57dd1aacb61a98605a295d3789f11">More...</a><br /></td></tr>
<tr class="separator:a50c57dd1aacb61a98605a295d3789f11"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae1721df1d000407fa538b00259de262e"><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="env_8h.html#ae1721df1d000407fa538b00259de262e">envGetHandle</a> (const char *name)</td></tr>
<tr class="memdesc:ae1721df1d000407fa538b00259de262e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves a handle from the environment handle list. <a href="env_8h.html#ae1721df1d000407fa538b00259de262e">More...</a><br /></td></tr>
<tr class="separator:ae1721df1d000407fa538b00259de262e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4d416f27dd79249cede1c7339fe08780"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="env_8h.html#a4d416f27dd79249cede1c7339fe08780">envGetAptAppId</a> (void)</td></tr>
<tr class="memdesc:a4d416f27dd79249cede1c7339fe08780"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the environment-recommended app ID to use with APT. <a href="env_8h.html#a4d416f27dd79249cede1c7339fe08780">More...</a><br /></td></tr>
<tr class="separator:a4d416f27dd79249cede1c7339fe08780"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa3efa8e6fd2e8d84001d2ed335253be4"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="env_8h.html#aa3efa8e6fd2e8d84001d2ed335253be4">envGetHeapSize</a> (void)</td></tr>
<tr class="memdesc:aa3efa8e6fd2e8d84001d2ed335253be4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the size of the application heap. <a href="env_8h.html#aa3efa8e6fd2e8d84001d2ed335253be4">More...</a><br /></td></tr>
<tr class="separator:aa3efa8e6fd2e8d84001d2ed335253be4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae6dc788bb31f582a9695659dde4373ac"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="env_8h.html#ae6dc788bb31f582a9695659dde4373ac">envGetLinearHeapSize</a> (void)</td></tr>
<tr class="memdesc:ae6dc788bb31f582a9695659dde4373ac"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the size of the linear heap. <a href="env_8h.html#ae6dc788bb31f582a9695659dde4373ac">More...</a><br /></td></tr>
<tr class="separator:ae6dc788bb31f582a9695659dde4373ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a47b91cce1bdd6c5667f674d5db3357dd"><td class="memItemLeft" align="right" valign="top">static const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="env_8h.html#a47b91cce1bdd6c5667f674d5db3357dd">envGetSystemArgList</a> (void)</td></tr>
<tr class="memdesc:a47b91cce1bdd6c5667f674d5db3357dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the environment argument list. <a href="env_8h.html#a47b91cce1bdd6c5667f674d5db3357dd">More...</a><br /></td></tr>
<tr class="separator:a47b91cce1bdd6c5667f674d5db3357dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aae27f53918b47d82bb59cc814a25fc15"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="env_8h.html#aae27f53918b47d82bb59cc814a25fc15">envGetSystemRunFlags</a> (void)</td></tr>
<tr class="memdesc:aae27f53918b47d82bb59cc814a25fc15"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the environment run flags. <a href="env_8h.html#aae27f53918b47d82bb59cc814a25fc15">More...</a><br /></td></tr>
<tr class="separator:aae27f53918b47d82bb59cc814a25fc15"><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>Homebrew environment information. </p>
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a726ca809ffd3d67ab4b8476646f26635"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a726ca809ffd3d67ab4b8476646f26635">&#9670;&nbsp;</a></span>anonymous enum</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">anonymous enum</td>
</tr>
</table>
</div><div class="memdoc">
<p>System run-flags. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a726ca809ffd3d67ab4b8476646f26635ad5366df45cecac4dad1f375eaa0555ab"></a>RUNFLAG_APTWORKAROUND&#160;</td><td class="fielddoc"><p>Use APT workaround. </p>
</td></tr>
<tr><td class="fieldname"><a id="a726ca809ffd3d67ab4b8476646f26635a426e94cb64bcd44449b1a13d3a977df8"></a>RUNFLAG_APTREINIT&#160;</td><td class="fielddoc"><p>Reinitialize APT. </p>
</td></tr>
<tr><td class="fieldname"><a id="a726ca809ffd3d67ab4b8476646f26635a5eedd97be189872a5f91a561fbe33c88"></a>RUNFLAG_APTCHAINLOAD&#160;</td><td class="fielddoc"><p>Chainload APT on return. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a4d416f27dd79249cede1c7339fe08780"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4d416f27dd79249cede1c7339fe08780">&#9670;&nbsp;</a></span>envGetAptAppId()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> envGetAptAppId </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the environment-recommended app ID to use with APT. </p>
<dl class="section return"><dt>Returns</dt><dd>The APT app ID. </dd></dl>
</div>
</div>
<a id="ae1721df1d000407fa538b00259de262e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae1721df1d000407fa538b00259de262e">&#9670;&nbsp;</a></span>envGetHandle()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> envGetHandle </td>
<td>(</td>
<td class="paramtype">const char *&#160;</td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves a handle from the environment handle list. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>Name of the handle. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The retrieved handle. </dd></dl>
</div>
</div>
<a id="aa3efa8e6fd2e8d84001d2ed335253be4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa3efa8e6fd2e8d84001d2ed335253be4">&#9670;&nbsp;</a></span>envGetHeapSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> envGetHeapSize </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the size of the application heap. </p>
<dl class="section return"><dt>Returns</dt><dd>The application heap size. </dd></dl>
</div>
</div>
<a id="ae6dc788bb31f582a9695659dde4373ac"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae6dc788bb31f582a9695659dde4373ac">&#9670;&nbsp;</a></span>envGetLinearHeapSize()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> envGetLinearHeapSize </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the size of the linear heap. </p>
<dl class="section return"><dt>Returns</dt><dd>The linear heap size. </dd></dl>
</div>
</div>
<a id="a47b91cce1bdd6c5667f674d5db3357dd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a47b91cce1bdd6c5667f674d5db3357dd">&#9670;&nbsp;</a></span>envGetSystemArgList()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static const char* envGetSystemArgList </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the environment argument list. </p>
<dl class="section return"><dt>Returns</dt><dd>The argument list. </dd></dl>
</div>
</div>
<a id="aae27f53918b47d82bb59cc814a25fc15"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aae27f53918b47d82bb59cc814a25fc15">&#9670;&nbsp;</a></span>envGetSystemRunFlags()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> envGetSystemRunFlags </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the environment run flags. </p>
<dl class="section return"><dt>Returns</dt><dd>The run flags. </dd></dl>
</div>
</div>
<a id="a50c57dd1aacb61a98605a295d3789f11"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a50c57dd1aacb61a98605a295d3789f11">&#9670;&nbsp;</a></span>envIsHomebrew()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static bool envIsHomebrew </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets whether the application was launched from a homebrew environment. </p>
<dl class="section return"><dt>Returns</dt><dd>Whether the application was launched from a homebrew environment. </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>
Reference in New Issue View Git Blame Copy Permalink