wut/group__sysapp__title.html
2020-03-26 16:49:18 +11:00

180 lines
8.6 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.8.17"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>wut: SYSAPP Title</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">wut
&#160;<span id="projectnumber">1.0.0-beta9</span>
</div>
<div id="projectbrief">Wii U Toolchain</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.17 -->
<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');
/* @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>
</div><!-- top -->
<!-- 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 class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">SYSAPP Title<div class="ingroups"><a class="el" href="group__sysapp.html">sysapp</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga9380615b71f7bd2dad28bec48b12b192"><td class="memItemLeft" align="right" valign="top"><a class="el" href="wut__types_8h.html#a975dbe9e4396bf9e0064ce01827fa372">BOOL</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sysapp__title.html#ga9380615b71f7bd2dad28bec48b12b192">SYSCheckTitleExists</a> (uint64_t TitleId)</td></tr>
<tr class="memdesc:ga9380615b71f7bd2dad28bec48b12b192"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if a given title exists and is installed on the system. <a href="group__sysapp__title.html#ga9380615b71f7bd2dad28bec48b12b192">More...</a><br /></td></tr>
<tr class="separator:ga9380615b71f7bd2dad28bec48b12b192"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga897d7edc8c28fd4145f138295e74be82"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sysapp__title.html#ga897d7edc8c28fd4145f138295e74be82">SYSGetPFIDFromTitleID</a> (uint64_t TitleId)</td></tr>
<tr class="memdesc:ga897d7edc8c28fd4145f138295e74be82"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the PFID/UPID for a given title. <a href="group__sysapp__title.html#ga897d7edc8c28fd4145f138295e74be82">More...</a><br /></td></tr>
<tr class="separator:ga897d7edc8c28fd4145f138295e74be82"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0fd47c17f5c12960163b3abdd3db5ffb"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__sysapp__title.html#ga0fd47c17f5c12960163b3abdd3db5ffb">SYSGetUPIDFromTitleID</a> (uint64_t TitleId)</td></tr>
<tr class="memdesc:ga0fd47c17f5c12960163b3abdd3db5ffb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the PFID/UPID for a given title. <a href="group__sysapp__title.html#ga0fd47c17f5c12960163b3abdd3db5ffb">More...</a><br /></td></tr>
<tr class="separator:ga0fd47c17f5c12960163b3abdd3db5ffb"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Functions to check titles and their IDs, as well as retreiving some metadata about them. </p>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga9380615b71f7bd2dad28bec48b12b192"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9380615b71f7bd2dad28bec48b12b192">&#9670;&nbsp;</a></span>SYSCheckTitleExists()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="wut__types_8h.html#a975dbe9e4396bf9e0064ce01827fa372">BOOL</a> SYSCheckTitleExists </td>
<td>(</td>
<td class="paramtype">uint64_t&#160;</td>
<td class="paramname"><em>TitleId</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if a given title exists and is installed on the system. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">TitleId</td><td>The ID of the title to check.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>TRUE</code> if the title exists, or <code>FALSE</code> otherwise. </dd></dl>
</div>
</div>
<a id="ga897d7edc8c28fd4145f138295e74be82"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga897d7edc8c28fd4145f138295e74be82">&#9670;&nbsp;</a></span>SYSGetPFIDFromTitleID()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t SYSGetPFIDFromTitleID </td>
<td>(</td>
<td class="paramtype">uint64_t&#160;</td>
<td class="paramname"><em>TitleId</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the PFID/UPID for a given title. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">TitleId</td><td>The ID of the title to get the PFID/UPID from.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The PFID/UPID for the title, or a negative value on error.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This function is identical to <a class="el" href="group__sysapp__title.html#ga0fd47c17f5c12960163b3abdd3db5ffb">SYSGetUPIDFromTitleID</a>. </dd></dl>
</div>
</div>
<a id="ga0fd47c17f5c12960163b3abdd3db5ffb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0fd47c17f5c12960163b3abdd3db5ffb">&#9670;&nbsp;</a></span>SYSGetUPIDFromTitleID()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t SYSGetUPIDFromTitleID </td>
<td>(</td>
<td class="paramtype">uint64_t&#160;</td>
<td class="paramname"><em>TitleId</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the PFID/UPID for a given title. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">TitleId</td><td>The ID of the title to get the PFID/UPID from.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The PFID/UPID for the title, or a negative value on error.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>This function is identical to <a class="el" href="group__sysapp__title.html#ga897d7edc8c28fd4145f138295e74be82">SYSGetPFIDFromTitleID</a>. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.17
</small></address>
</body>
</html>