The-Homebrew-Cloud/wut
2
0
Fork 0
mirror of https://github.com/wiiu-env/wut.git synced 2025-01-09 17:29:38 +01:00
Code Issues Packages Projects Releases Wiki Activity
wut/group__nn__ac__c.html

264 lines
15 KiB
HTML
Raw Normal View History

docs: Regenrate against 1.0.0-beta8
2019-04-22 10:21:17 +10:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
Rebuild doxygen docs from 4ff6c40
2018-07-26 20:52:03 +10:00
<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"/>
docs: Regenrate against 1.0.0-beta8
2019-04-22 10:21:17 +10:00
<meta name="generator" content="Doxygen 1.8.15"/>
Rebuild doxygen docs from 4ff6c40
2018-07-26 20:52:03 +10:00
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>wut: Auto Connect C API</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
docs: Regenrate against 1.0.0-beta8
2019-04-22 10:21:17 +10:00
&#160;<span id="projectnumber">1.0.0-beta8</span>
Rebuild doxygen docs from 4ff6c40
2018-07-26 20:52:03 +10:00
</div>
<div id="projectbrief">Wii U Toolchain</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
docs: Regenrate against 1.0.0-beta8
2019-04-22 10:21:17 +10:00
<!-- Generated by Doxygen 1.8.15 -->
Rebuild doxygen docs from 4ff6c40
2018-07-26 20:52:03 +10:00
<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="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Auto Connect C API<div class="ingroups"><a class="el" href="group__nn__ac.html">nn_ac</a></div></div> </div>
</div><!--header-->
<div class="contents">
docs: Regenrate against 1.0.0-beta8
2019-04-22 10:21:17 +10:00
<p>C functions for the Auto Connect API.
<a href="#details">More...</a></p>
Rebuild doxygen docs from 4ff6c40
2018-07-26 20:52:03 +10:00
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:gac4a8e848f723536de1ae83651cd91d8d"><td class="memItemLeft" align="right" valign="top">typedef uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nn__ac__c.html#gac4a8e848f723536de1ae83651cd91d8d">ACConfigId</a></td></tr>
docs: Regenrate against 1.0.0-beta8
2019-04-22 10:21:17 +10:00
<tr class="memdesc:gac4a8e848f723536de1ae83651cd91d8d"><td class="mdescLeft">&#160;</td><td class="mdescRight">An ID number representing a network configuration. <a href="#gac4a8e848f723536de1ae83651cd91d8d">More...</a><br /></td></tr>
Rebuild doxygen docs from 4ff6c40
2018-07-26 20:52:03 +10:00
<tr class="separator:gac4a8e848f723536de1ae83651cd91d8d"><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:ga1456945fe4303e08071b97571b20d807"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__nn__result.html#structNNResult">NNResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nn__ac__c.html#ga1456945fe4303e08071b97571b20d807">ACInitialize</a> ()</td></tr>
docs: Regenrate against 1.0.0-beta8
2019-04-22 10:21:17 +10:00
<tr class="memdesc:ga1456945fe4303e08071b97571b20d807"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise the Auto Connect library. <a href="#ga1456945fe4303e08071b97571b20d807">More...</a><br /></td></tr>
Rebuild doxygen docs from 4ff6c40
2018-07-26 20:52:03 +10:00
<tr class="separator:ga1456945fe4303e08071b97571b20d807"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaccea212848e9bdb550d734004f130102"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nn__ac__c.html#gaccea212848e9bdb550d734004f130102">ACFinalize</a> ()</td></tr>
docs: Regenrate against 1.0.0-beta8
2019-04-22 10:21:17 +10:00
<tr class="memdesc:gaccea212848e9bdb550d734004f130102"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cleanup the Auto Connect library. <a href="#gaccea212848e9bdb550d734004f130102">More...</a><br /></td></tr>
Rebuild doxygen docs from 4ff6c40
2018-07-26 20:52:03 +10:00
<tr class="separator:gaccea212848e9bdb550d734004f130102"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae41d02a4ead38ff75bc2929354818fbb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__nn__result.html#structNNResult">NNResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nn__ac__c.html#gae41d02a4ead38ff75bc2929354818fbb">ACGetStartupId</a> (<a class="el" href="group__nn__ac__c.html#gac4a8e848f723536de1ae83651cd91d8d">ACConfigId</a> *configId)</td></tr>
docs: Regenrate against 1.0.0-beta8
2019-04-22 10:21:17 +10:00
<tr class="memdesc:gae41d02a4ead38ff75bc2929354818fbb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the default connection configuration id. <a href="#gae41d02a4ead38ff75bc2929354818fbb">More...</a><br /></td></tr>
Rebuild doxygen docs from 4ff6c40
2018-07-26 20:52:03 +10:00
<tr class="separator:gae41d02a4ead38ff75bc2929354818fbb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae0e6fe9fa1d5d34fcda301779032dfa8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__nn__result.html#structNNResult">NNResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nn__ac__c.html#gae0e6fe9fa1d5d34fcda301779032dfa8">ACConnectWithConfigId</a> (<a class="el" href="group__nn__ac__c.html#gac4a8e848f723536de1ae83651cd91d8d">ACConfigId</a> configId)</td></tr>
docs: Regenrate against 1.0.0-beta8
2019-04-22 10:21:17 +10:00
<tr class="memdesc:gae0e6fe9fa1d5d34fcda301779032dfa8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connects to a network, using the configuration represented by the given <a class="el" href="group__nn__ac__c.html#gac4a8e848f723536de1ae83651cd91d8d">ACConfigId</a>. <a href="#gae0e6fe9fa1d5d34fcda301779032dfa8">More...</a><br /></td></tr>
Rebuild doxygen docs from 4ff6c40
2018-07-26 20:52:03 +10:00
<tr class="separator:gae0e6fe9fa1d5d34fcda301779032dfa8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6902f96dba0239d580ad0eb9dd0d131f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__nn__result.html#structNNResult">NNResult</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__nn__ac__c.html#ga6902f96dba0239d580ad0eb9dd0d131f">ACGetAssignedAddress</a> (uint32_t *ip)</td></tr>
docs: Regenrate against 1.0.0-beta8
2019-04-22 10:21:17 +10:00
<tr class="memdesc:ga6902f96dba0239d580ad0eb9dd0d131f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the IP address assosciated with the currently active connection. <a href="#ga6902f96dba0239d580ad0eb9dd0d131f">More...</a><br /></td></tr>
Rebuild doxygen docs from 4ff6c40
2018-07-26 20:52:03 +10:00
<tr class="separator:ga6902f96dba0239d580ad0eb9dd0d131f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
docs: Regenrate against 1.0.0-beta8
2019-04-22 10:21:17 +10:00
<p>C functions for the Auto Connect API. </p>
Rebuild doxygen docs from 4ff6c40
2018-07-26 20:52:03 +10:00
<h2 class="groupheader">Typedef Documentation</h2>
<a id="gac4a8e848f723536de1ae83651cd91d8d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac4a8e848f723536de1ae83651cd91d8d">&#9670;&nbsp;</a></span>ACConfigId</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef uint32_t <a class="el" href="group__nn__ac__c.html#gac4a8e848f723536de1ae83651cd91d8d">ACConfigId</a></td>
</tr>
</table>
</div><div class="memdoc">
docs: Regenrate against 1.0.0-beta8
2019-04-22 10:21:17 +10:00
<p>An ID number representing a network configuration. </p>
<p>These are the same IDs as shown in System Settings' Connection List. </p>
<p class="definition">Definition at line <a class="el" href="ac__c_8h_source.html#l00020">20</a> of file <a class="el" href="ac__c_8h_source.html">ac_c.h</a>.</p>
Rebuild doxygen docs from 4ff6c40
2018-07-26 20:52:03 +10:00
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga1456945fe4303e08071b97571b20d807"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga1456945fe4303e08071b97571b20d807">&#9670;&nbsp;</a></span>ACInitialize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__nn__result.html#structNNResult">NNResult</a> ACInitialize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
docs: Regenrate against 1.0.0-beta8
2019-04-22 10:21:17 +10:00
<p>Initialise the Auto Connect library. </p>
<p>Call this function before any other AC functions.</p>
<dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="group__nn__result.html">Result</a> - see <a class="el" href="group__nn__result.html#ga4160f94e09672fbf59c46cb8ef4b732b">NNResult_IsSuccess</a> and <a class="el" href="group__nn__result.html#ga035e23b8947fe268f21b3a3f7c7edb3b">NNResult_IsFailure</a>.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><ul>
<li><a class="el" href="group__nn__ac__c.html#gaccea212848e9bdb550d734004f130102">ACFinalize</a> </li>
</ul>
</dd></dl>
Rebuild doxygen docs from 4ff6c40
2018-07-26 20:52:03 +10:00
</div>
</div>
<a id="gaccea212848e9bdb550d734004f130102"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaccea212848e9bdb550d734004f130102">&#9670;&nbsp;</a></span>ACFinalize()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ACFinalize </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
docs: Regenrate against 1.0.0-beta8
2019-04-22 10:21:17 +10:00
<p>Cleanup the Auto Connect library. </p>
<p>Do not call any AC functions (other than <a class="el" href="group__nn__ac__c.html#ga1456945fe4303e08071b97571b20d807">ACInitialize</a>) after calling this function.</p>
<dl class="section see"><dt>See also</dt><dd><ul>
<li><a class="el" href="group__nn__ac__c.html#ga1456945fe4303e08071b97571b20d807">ACInitialize</a> </li>
</ul>
</dd></dl>
Rebuild doxygen docs from 4ff6c40
2018-07-26 20:52:03 +10:00
</div>
</div>
<a id="gae41d02a4ead38ff75bc2929354818fbb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae41d02a4ead38ff75bc2929354818fbb">&#9670;&nbsp;</a></span>ACGetStartupId()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__nn__result.html#structNNResult">NNResult</a> ACGetStartupId </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__nn__ac__c.html#gac4a8e848f723536de1ae83651cd91d8d">ACConfigId</a> *&#160;</td>
<td class="paramname"><em>configId</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
docs: Regenrate against 1.0.0-beta8
2019-04-22 10:21:17 +10:00
<p>Gets the default connection configuration id. </p>
<p>This is the default as marked in System Settings.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">configId</td><td>A pointer to an <a class="el" href="group__nn__ac__c.html#gac4a8e848f723536de1ae83651cd91d8d">ACConfigId</a> to write the config ID to. Must not be <code>NULL</code>.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="group__nn__result.html">Result</a> - see <a class="el" href="group__nn__result.html#ga4160f94e09672fbf59c46cb8ef4b732b">NNResult_IsSuccess</a> and <a class="el" href="group__nn__result.html#ga035e23b8947fe268f21b3a3f7c7edb3b">NNResult_IsFailure</a>. </dd></dl>
Rebuild doxygen docs from 4ff6c40
2018-07-26 20:52:03 +10:00
</div>
</div>
<a id="gae0e6fe9fa1d5d34fcda301779032dfa8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae0e6fe9fa1d5d34fcda301779032dfa8">&#9670;&nbsp;</a></span>ACConnectWithConfigId()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__nn__result.html#structNNResult">NNResult</a> ACConnectWithConfigId </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__nn__ac__c.html#gac4a8e848f723536de1ae83651cd91d8d">ACConfigId</a>&#160;</td>
<td class="paramname"><em>configId</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
docs: Regenrate against 1.0.0-beta8
2019-04-22 10:21:17 +10:00
<p>Connects to a network, using the configuration represented by the given <a class="el" href="group__nn__ac__c.html#gac4a8e848f723536de1ae83651cd91d8d">ACConfigId</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">configId</td><td>The <a class="el" href="group__nn__ac__c.html#gac4a8e848f723536de1ae83651cd91d8d">ACConfigId</a> representing the network to connect to.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="group__nn__result.html">Result</a> - see <a class="el" href="group__nn__result.html#ga4160f94e09672fbf59c46cb8ef4b732b">NNResult_IsSuccess</a> and <a class="el" href="group__nn__result.html#ga035e23b8947fe268f21b3a3f7c7edb3b">NNResult_IsFailure</a>. </dd></dl>
Rebuild doxygen docs from 4ff6c40
2018-07-26 20:52:03 +10:00
</div>
</div>
<a id="ga6902f96dba0239d580ad0eb9dd0d131f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6902f96dba0239d580ad0eb9dd0d131f">&#9670;&nbsp;</a></span>ACGetAssignedAddress()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group__nn__result.html#structNNResult">NNResult</a> ACGetAssignedAddress </td>
<td>(</td>
<td class="paramtype">uint32_t *&#160;</td>
<td class="paramname"><em>ip</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
docs: Regenrate against 1.0.0-beta8
2019-04-22 10:21:17 +10:00
<p>Gets the IP address assosciated with the currently active connection. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">ip</td><td>A pointer to write the IP address to, in <a href="https://en.wikipedia.org/wiki/IPv4#Address_representations" target="_blank">numerical</a> form.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="group__nn__result.html">Result</a> - see <a class="el" href="group__nn__result.html#ga4160f94e09672fbf59c46cb8ef4b732b">NNResult_IsSuccess</a> and <a class="el" href="group__nn__result.html#ga035e23b8947fe268f21b3a3f7c7edb3b">NNResult_IsFailure</a>. </dd></dl>
Rebuild doxygen docs from 4ff6c40
2018-07-26 20:52:03 +10:00
</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"/>
docs: Regenrate against 1.0.0-beta8
2019-04-22 10:21:17 +10:00
</a> 1.8.15
Rebuild doxygen docs from 4ff6c40
2018-07-26 20:52:03 +10:00
</small></address>
</body>
</html>
Reference in New Issue Copy Permalink