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

325 lines
18 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: nn::ac Namespace 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">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>
<!-- 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="namespacenn.html">nn</a></li><li class="navelem"><a class="el" href="namespacenn_1_1ac.html">ac</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#namespaces">Namespaces</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">nn::ac Namespace Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Auto Connect API, used for managing and connecting to internet connection profiles.
<a href="namespacenn_1_1ac.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespacenn_1_1ac_1_1detail"><td class="memItemLeft" align="right" valign="top"> &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenn_1_1ac_1_1detail.html">detail</a></td></tr>
<tr class="memdesc:namespacenn_1_1ac_1_1detail"><td class="mdescLeft">&#160;</td><td class="mdescRight">C++ linkage for the autoconnect API, see <a class="el" href="namespacenn_1_1ac.html">nn::ac</a> for use. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a5bacb2d46ed8fa98f8dc634297f214c0"><td class="memItemLeft" align="right" valign="top">typedef uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenn_1_1ac.html#a5bacb2d46ed8fa98f8dc634297f214c0">ConfigIdNum</a></td></tr>
<tr class="memdesc:a5bacb2d46ed8fa98f8dc634297f214c0"><td class="mdescLeft">&#160;</td><td class="mdescRight">An ID number representing a network configuration. <a href="namespacenn_1_1ac.html#a5bacb2d46ed8fa98f8dc634297f214c0">More...</a><br /></td></tr>
<tr class="separator:a5bacb2d46ed8fa98f8dc634297f214c0"><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:ac53ccf07af2b6a1ac33d065499677f49"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classnn_1_1Result.html">nn::Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenn_1_1ac.html#ac53ccf07af2b6a1ac33d065499677f49">Initialize</a> ()</td></tr>
<tr class="memdesc:ac53ccf07af2b6a1ac33d065499677f49"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialise the Auto Connect library. <a href="namespacenn_1_1ac.html#ac53ccf07af2b6a1ac33d065499677f49">More...</a><br /></td></tr>
<tr class="separator:ac53ccf07af2b6a1ac33d065499677f49"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aad222ee462945359df6feee2ed285627"><td class="memItemLeft" align="right" valign="top">static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenn_1_1ac.html#aad222ee462945359df6feee2ed285627">Finalize</a> ()</td></tr>
<tr class="memdesc:aad222ee462945359df6feee2ed285627"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cleanup the Auto Connect library. <a href="namespacenn_1_1ac.html#aad222ee462945359df6feee2ed285627">More...</a><br /></td></tr>
<tr class="separator:aad222ee462945359df6feee2ed285627"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abd7a2fdb9a2c1043f5cf4bb7f5c94eb8"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classnn_1_1Result.html">nn::Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenn_1_1ac.html#abd7a2fdb9a2c1043f5cf4bb7f5c94eb8">GetStartupId</a> (<a class="el" href="namespacenn_1_1ac.html#a5bacb2d46ed8fa98f8dc634297f214c0">ConfigIdNum</a> *id)</td></tr>
<tr class="memdesc:abd7a2fdb9a2c1043f5cf4bb7f5c94eb8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the default connection configuration id. <a href="namespacenn_1_1ac.html#abd7a2fdb9a2c1043f5cf4bb7f5c94eb8">More...</a><br /></td></tr>
<tr class="separator:abd7a2fdb9a2c1043f5cf4bb7f5c94eb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad140c53f4fc92991b05a63fdb2eef434"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classnn_1_1Result.html">nn::Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenn_1_1ac.html#ad140c53f4fc92991b05a63fdb2eef434">Connect</a> (<a class="el" href="namespacenn_1_1ac.html#a5bacb2d46ed8fa98f8dc634297f214c0">ConfigIdNum</a> id)</td></tr>
<tr class="memdesc:ad140c53f4fc92991b05a63fdb2eef434"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connects to a network, using the configuration represented by the given <a class="el" href="namespacenn_1_1ac.html#a5bacb2d46ed8fa98f8dc634297f214c0">ConfigIdNum</a>. <a href="namespacenn_1_1ac.html#ad140c53f4fc92991b05a63fdb2eef434">More...</a><br /></td></tr>
<tr class="separator:ad140c53f4fc92991b05a63fdb2eef434"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7ed262623e6936e9a94c25c2310545fa"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classnn_1_1Result.html">nn::Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespacenn_1_1ac.html#a7ed262623e6936e9a94c25c2310545fa">GetAssignedAddress</a> (uint32_t *ip)</td></tr>
<tr class="memdesc:a7ed262623e6936e9a94c25c2310545fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the IP address assosciated with the currently active connection. <a href="namespacenn_1_1ac.html#a7ed262623e6936e9a94c25c2310545fa">More...</a><br /></td></tr>
<tr class="separator:a7ed262623e6936e9a94c25c2310545fa"><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>Auto Connect API, used for managing and connecting to internet connection profiles. </p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a id="a5bacb2d46ed8fa98f8dc634297f214c0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5bacb2d46ed8fa98f8dc634297f214c0">&#9670;&nbsp;</a></span>ConfigIdNum</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef uint32_t <a class="el" href="namespacenn_1_1ac.html#a5bacb2d46ed8fa98f8dc634297f214c0">ConfigIdNum</a></td>
</tr>
</table>
</div><div class="memdoc">
<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__cpp_8h_source.html#l00027">27</a> of file <a class="el" href="ac__cpp_8h_source.html">ac_cpp.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ac53ccf07af2b6a1ac33d065499677f49"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac53ccf07af2b6a1ac33d065499677f49">&#9670;&nbsp;</a></span>Initialize()</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="classnn_1_1Result.html">nn::Result</a> nn::ac::Initialize </td>
<td>(</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>Initialise the Auto Connect library. </p>
<p>Call this function before any other <a class="el" href="namespacenn_1_1ac.html" title="Auto Connect API, used for managing and connecting to internet connection profiles.">nn::ac</a> functions.</p>
<dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="classnn_1_1Result.html">Result</a> - see <a class="el" href="classnn_1_1Result.html#a4a5720ba6ebde5032388ab13ce9f6956">nn::Result::IsSuccess</a> and <a class="el" href="classnn_1_1Result.html#a75213f2532d8e51b9c3b026b5895bde4">nn::Result::IsFailure</a>.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><ul>
<li><a class="el" href="namespacenn_1_1ac.html#aad222ee462945359df6feee2ed285627">Finalize</a> </li>
</ul>
</dd></dl>
<p class="definition">Definition at line <a class="el" href="ac__cpp_8h_source.html#l00060">60</a> of file <a class="el" href="ac__cpp_8h_source.html">ac_cpp.h</a>.</p>
</div>
</div>
<a id="aad222ee462945359df6feee2ed285627"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aad222ee462945359df6feee2ed285627">&#9670;&nbsp;</a></span>Finalize()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void nn::ac::Finalize </td>
<td>(</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>Cleanup the Auto Connect library. </p>
<p>Do not call any <a class="el" href="namespacenn_1_1ac.html" title="Auto Connect API, used for managing and connecting to internet connection profiles.">nn::ac</a> functions (other than <a class="el" href="namespacenn_1_1ac.html#ac53ccf07af2b6a1ac33d065499677f49">Initialize</a>) after calling this function.</p>
<dl class="section see"><dt>See also</dt><dd><ul>
<li><a class="el" href="namespacenn_1_1ac.html#ac53ccf07af2b6a1ac33d065499677f49">Initialize</a> </li>
</ul>
</dd></dl>
<p class="definition">Definition at line <a class="el" href="ac__cpp_8h_source.html#l00073">73</a> of file <a class="el" href="ac__cpp_8h_source.html">ac_cpp.h</a>.</p>
</div>
</div>
<a id="abd7a2fdb9a2c1043f5cf4bb7f5c94eb8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abd7a2fdb9a2c1043f5cf4bb7f5c94eb8">&#9670;&nbsp;</a></span>GetStartupId()</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="classnn_1_1Result.html">nn::Result</a> nn::ac::GetStartupId </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacenn_1_1ac.html#a5bacb2d46ed8fa98f8dc634297f214c0">ConfigIdNum</a> *&#160;</td>
<td class="paramname"><em>id</em></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 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">id</td><td>A pointer to an <a class="el" href="namespacenn_1_1ac.html#a5bacb2d46ed8fa98f8dc634297f214c0">ConfigIdNum</a> to write the config ID to. Must not be a <code>nullptr</code>.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A <a class="el" href="classnn_1_1Result.html">Result</a> - see <a class="el" href="classnn_1_1Result.html#a4a5720ba6ebde5032388ab13ce9f6956">nn::Result::IsSuccess</a> and <a class="el" href="classnn_1_1Result.html#a75213f2532d8e51b9c3b026b5895bde4">nn::Result::IsFailure</a>. </dd></dl>
<p class="definition">Definition at line <a class="el" href="ac__cpp_8h_source.html#l00092">92</a> of file <a class="el" href="ac__cpp_8h_source.html">ac_cpp.h</a>.</p>
</div>
</div>
<a id="ad140c53f4fc92991b05a63fdb2eef434"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad140c53f4fc92991b05a63fdb2eef434">&#9670;&nbsp;</a></span>Connect()</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="classnn_1_1Result.html">nn::Result</a> nn::ac::Connect </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespacenn_1_1ac.html#a5bacb2d46ed8fa98f8dc634297f214c0">ConfigIdNum</a>&#160;</td>
<td class="paramname"><em>id</em></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>Connects to a network, using the configuration represented by the given <a class="el" href="namespacenn_1_1ac.html#a5bacb2d46ed8fa98f8dc634297f214c0">ConfigIdNum</a>. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">id</td><td>The <a class="el" href="namespacenn_1_1ac.html#a5bacb2d46ed8fa98f8dc634297f214c0">ConfigIdNum</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="classnn_1_1Result.html">Result</a> - see <a class="el" href="classnn_1_1Result.html#a4a5720ba6ebde5032388ab13ce9f6956">nn::Result::IsSuccess</a> and <a class="el" href="classnn_1_1Result.html#a75213f2532d8e51b9c3b026b5895bde4">nn::Result::IsFailure</a>. </dd></dl>
<p class="definition">Definition at line <a class="el" href="ac__cpp_8h_source.html#l00109">109</a> of file <a class="el" href="ac__cpp_8h_source.html">ac_cpp.h</a>.</p>
</div>
</div>
<a id="a7ed262623e6936e9a94c25c2310545fa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7ed262623e6936e9a94c25c2310545fa">&#9670;&nbsp;</a></span>GetAssignedAddress()</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="classnn_1_1Result.html">nn::Result</a> nn::ac::GetAssignedAddress </td>
<td>(</td>
<td class="paramtype">uint32_t *&#160;</td>
<td class="paramname"><em>ip</em></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 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="classnn_1_1Result.html">Result</a> - see <a class="el" href="classnn_1_1Result.html#a4a5720ba6ebde5032388ab13ce9f6956">nn::Result::IsSuccess</a> and <a class="el" href="classnn_1_1Result.html#a75213f2532d8e51b9c3b026b5895bde4">nn::Result::IsFailure</a>. </dd></dl>
<p class="definition">Definition at line <a class="el" href="ac__cpp_8h_source.html#l00127">127</a> of file <a class="el" href="ac__cpp_8h_source.html">ac_cpp.h</a>.</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.17
</small></address>
</body>
</html>