wut/group__coreinit__dynload.html
2016-01-07 16:14:21 +00:00

304 lines
14 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.10"/>
<title>WUT: Dynamic Loading</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>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</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">0.1</span>
</div>
<div id="projectbrief">Wii U Toolchain</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.10 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</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="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Dynamic Loading<div class="ingroups"><a class="el" href="group__coreinit.html">coreinit</a></div></div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga12318fb85060b2418e81c00d6011380b"><td class="memItemLeft" align="right" valign="top">typedef void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__dynload.html#ga12318fb85060b2418e81c00d6011380b">OSDynLoadModule</a></td></tr>
<tr class="separator:ga12318fb85060b2418e81c00d6011380b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga227b8418ab26a6999ec693bd580194b3"><td class="memItemLeft" align="right" valign="top">typedef int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__dynload.html#ga227b8418ab26a6999ec693bd580194b3">OSDynLoadAllocFn</a>) (int size, int align, void **outAddr)</td></tr>
<tr class="separator:ga227b8418ab26a6999ec693bd580194b3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga09658d49df7c02cbe47b5043fb81c211"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__dynload.html#ga09658d49df7c02cbe47b5043fb81c211">OSDynLoadFreeFn</a>) (void *addr)</td></tr>
<tr class="separator:ga09658d49df7c02cbe47b5043fb81c211"><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:ga45ea96c58b89b0a32b74fe0f41c6c634"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__dynload.html#ga45ea96c58b89b0a32b74fe0f41c6c634">OSDynLoad_SetAllocator</a> (<a class="el" href="group__coreinit__dynload.html#ga227b8418ab26a6999ec693bd580194b3">OSDynLoadAllocFn</a> allocFn, <a class="el" href="group__coreinit__dynload.html#ga09658d49df7c02cbe47b5043fb81c211">OSDynLoadFreeFn</a> freeFn)</td></tr>
<tr class="separator:ga45ea96c58b89b0a32b74fe0f41c6c634"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga1ff486dcb5ef633a92e15e86c666c23f"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__dynload.html#ga1ff486dcb5ef633a92e15e86c666c23f">OSDynLoad_GetAllocator</a> (<a class="el" href="group__coreinit__dynload.html#ga227b8418ab26a6999ec693bd580194b3">OSDynLoadAllocFn</a> *outAllocFn, <a class="el" href="group__coreinit__dynload.html#ga09658d49df7c02cbe47b5043fb81c211">OSDynLoadFreeFn</a> *outFreeFn)</td></tr>
<tr class="separator:ga1ff486dcb5ef633a92e15e86c666c23f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gab050109e4f173d18855f0f79d390d9ac"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__dynload.html#gab050109e4f173d18855f0f79d390d9ac">OSDynLoad_Acquire</a> (char const *name, <a class="el" href="group__coreinit__dynload.html#ga12318fb85060b2418e81c00d6011380b">OSDynLoadModule</a> *outModule)</td></tr>
<tr class="separator:gab050109e4f173d18855f0f79d390d9ac"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8f97da3f1cf0deccdbcdf10bfe39868c"><td class="memItemLeft" align="right" valign="top">int32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__dynload.html#ga8f97da3f1cf0deccdbcdf10bfe39868c">OSDynLoad_FindExport</a> (<a class="el" href="group__coreinit__dynload.html#ga12318fb85060b2418e81c00d6011380b">OSDynLoadModule</a> module, int32_t isData, char const *name, void **outAddr)</td></tr>
<tr class="separator:ga8f97da3f1cf0deccdbcdf10bfe39868c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga753a983f6b633ee4cc54fe2f5a86b55c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__coreinit__dynload.html#ga753a983f6b633ee4cc54fe2f5a86b55c">OSDynLoad_Release</a> (<a class="el" href="group__coreinit__dynload.html#ga12318fb85060b2418e81c00d6011380b">OSDynLoadModule</a> module)</td></tr>
<tr class="separator:ga753a983f6b633ee4cc54fe2f5a86b55c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="ga227b8418ab26a6999ec693bd580194b3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int(* OSDynLoadAllocFn) (int size, int align, void **outAddr)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="dynload_8h_source.html#l00018">18</a> of file <a class="el" href="dynload_8h_source.html">dynload.h</a>.</p>
</div>
</div>
<a class="anchor" id="ga09658d49df7c02cbe47b5043fb81c211"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* OSDynLoadFreeFn) (void *addr)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="dynload_8h_source.html#l00019">19</a> of file <a class="el" href="dynload_8h_source.html">dynload.h</a>.</p>
</div>
</div>
<a class="anchor" id="ga12318fb85060b2418e81c00d6011380b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void* <a class="el" href="group__coreinit__dynload.html#ga12318fb85060b2418e81c00d6011380b">OSDynLoadModule</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="dynload_8h_source.html#l00016">16</a> of file <a class="el" href="dynload_8h_source.html">dynload.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gab050109e4f173d18855f0f79d390d9ac"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t OSDynLoad_Acquire </td>
<td>(</td>
<td class="paramtype">char const *&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__coreinit__dynload.html#ga12318fb85060b2418e81c00d6011380b">OSDynLoadModule</a> *&#160;</td>
<td class="paramname"><em>outModule</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Load a module.</p>
<p>If the module is already loaded, increase reference count. Similar to LoadLibrary on Windows. </p>
</div>
</div>
<a class="anchor" id="ga8f97da3f1cf0deccdbcdf10bfe39868c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t OSDynLoad_FindExport </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__coreinit__dynload.html#ga12318fb85060b2418e81c00d6011380b">OSDynLoadModule</a>&#160;</td>
<td class="paramname"><em>module</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int32_t&#160;</td>
<td class="paramname"><em>isData</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char const *&#160;</td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void **&#160;</td>
<td class="paramname"><em>outAddr</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieve the address of a function or data export from a module.</p>
<p>Similar to GetProcAddress on Windows. </p>
</div>
</div>
<a class="anchor" id="ga1ff486dcb5ef633a92e15e86c666c23f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t OSDynLoad_GetAllocator </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__coreinit__dynload.html#ga227b8418ab26a6999ec693bd580194b3">OSDynLoadAllocFn</a> *&#160;</td>
<td class="paramname"><em>outAllocFn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__coreinit__dynload.html#ga09658d49df7c02cbe47b5043fb81c211">OSDynLoadFreeFn</a> *&#160;</td>
<td class="paramname"><em>outFreeFn</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the allocator function used for dynamic loading. </p>
</div>
</div>
<a class="anchor" id="ga753a983f6b633ee4cc54fe2f5a86b55c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void OSDynLoad_Release </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__coreinit__dynload.html#ga12318fb85060b2418e81c00d6011380b">OSDynLoadModule</a>&#160;</td>
<td class="paramname"><em>module</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free a module handle returned from OSDynLoad_Acquire.</p>
<p>Will decrease reference count and only unload the module if count reaches 0. Similar to FreeLibrary on Windows. </p>
</div>
</div>
<a class="anchor" id="ga45ea96c58b89b0a32b74fe0f41c6c634"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int32_t OSDynLoad_SetAllocator </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__coreinit__dynload.html#ga227b8418ab26a6999ec693bd580194b3">OSDynLoadAllocFn</a>&#160;</td>
<td class="paramname"><em>allocFn</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__coreinit__dynload.html#ga09658d49df7c02cbe47b5043fb81c211">OSDynLoadFreeFn</a>&#160;</td>
<td class="paramname"><em>freeFn</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the allocator function to use for dynamic loading. </p>
</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.10
</small></address>
</body>
</html>