399 lines
72 KiB
HTML
399 lines
72 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.9.1"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>libctru: include/3ds/services/frd.h Source File</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
|
|
 <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&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&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><li class="navelem"><a class="el" href="dir_0e005207343684f6967052d1f51a7e66.html">services</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">frd.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="frd_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * @file frd.h</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * @brief Friend Services</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="preprocessor">#include <<a class="code" href="mii_8h.html">3ds/mii.h</a>></span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>  </div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"><a class="line" href="frd_8h.html#ad2feecb713f820cbcd168f19e4f55866"> 8</a></span> <span class="preprocessor">#define FRIEND_SCREEN_NAME_SIZE 0xB </span><span class="comment">///< 11-byte UTF-16 screen name</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"><a class="line" href="frd_8h.html#ac300c5a4b565eaaf656d7fc6a82dd10b"> 9</a></span> <span class="preprocessor">#define FRIEND_COMMENT_SIZE 0x21 </span><span class="comment">///< 33-byte UTF-16 comment</span></div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"><a class="line" href="frd_8h.html#a4426da9cb91df71e799ca69d9ed40a4e"> 10</a></span> <span class="preprocessor">#define FRIEND_LIST_SIZE 0x64 </span><span class="comment">///< 100 (Max number of friends)</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>  </div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="preprocessor">#pragma pack(push, 1)</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">/// Friend key data</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"><a class="line" href="structFriendKey.html"> 15</a></span> <span class="comment"></span><span class="keyword">typedef</span> <span class="keyword">struct</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> {</div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>  <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> principalId;</div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> padding;</div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  <a class="code" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> localFriendCode;</div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> } <a class="code" href="structFriendKey.html">FriendKey</a>;</div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">/// Friend Title data</span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="structTitleData.html"> 23</a></span> <span class="comment"></span><span class="keyword">typedef</span> <span class="keyword">struct</span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> {</div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  <a class="code" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> tid;</div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> version;</div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> unk;</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> } <a class="code" href="structTitleData.html">TitleData</a>;</div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">/// Friend profile data</span></div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="structFriendProfile.html"> 31</a></span> <span class="comment"></span><span class="keyword">typedef</span> <span class="keyword">struct</span></div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> {</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="structFriendProfile.html#aa93f7353683eae976b64232206c49418"> 33</a></span>  <a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> <a class="code" href="structFriendProfile.html#aa93f7353683eae976b64232206c49418">region</a>; <span class="comment">///< The region code for the hardware.</span></div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"><a class="line" href="structFriendProfile.html#abae6e8315e5692c6b0cb0e8702a3fcbb"> 34</a></span>  <a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> <a class="code" href="structFriendProfile.html#abae6e8315e5692c6b0cb0e8702a3fcbb">country</a>; <span class="comment">///< Country code.</span></div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"><a class="line" href="structFriendProfile.html#abd435b314f8831ff5cf6161b7ea1fb0a"> 35</a></span>  <a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> <a class="code" href="structFriendProfile.html#abd435b314f8831ff5cf6161b7ea1fb0a">area</a>; <span class="comment">///< Area code.</span></div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="structFriendProfile.html#acd0c5cfc685f6384f26c0d55bca0f611"> 36</a></span>  <a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> <a class="code" href="structFriendProfile.html#acd0c5cfc685f6384f26c0d55bca0f611">language</a>; <span class="comment">///< Language code.</span></div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"><a class="line" href="structFriendProfile.html#a3ecaf8888bcc2c4d649c5a6c2b173f89"> 37</a></span>  <a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> <a class="code" href="structFriendProfile.html#a3ecaf8888bcc2c4d649c5a6c2b173f89">platform</a>; <span class="comment">///< Platform code.</span></div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> padding;</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> } <a class="code" href="structFriendProfile.html">FriendProfile</a>;</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment">/// Game Description structure</span></div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="structGameDescription.html"> 42</a></span> <span class="comment"></span><span class="keyword">typedef</span> <span class="keyword">struct</span></div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span> {</div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <a class="code" href="structTitleData.html">TitleData</a> data;</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <a class="code" href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a> desc[128];</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> } <a class="code" href="structGameDescription.html">GameDescription</a>;</div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment">/// Friend Notification Event structure</span></div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"><a class="line" href="structNotificationEvent.html"> 49</a></span> <span class="comment"></span><span class="keyword">typedef</span> <span class="keyword">struct</span></div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> {</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> type;</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <a class="code" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> padding3[3];</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> padding;</div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  <a class="code" href="structFriendKey.html">FriendKey</a> key;</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> } <a class="code" href="structNotificationEvent.html">NotificationEvent</a>;</div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  </div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor">#pragma pack(pop)</span></div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment">/// Enum to use with FRD_GetNotificationEvent</span></div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="frd_8h.html#a943bc52f706bd0462355f5dc74d210ce"> 60</a></span> <span class="comment"></span><span class="keyword">typedef</span> <span class="keyword">enum</span> </div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> {</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="frd_8h.html#a943bc52f706bd0462355f5dc74d210ceac207d63c32cf5df4f16d86d424eeaaad"> 62</a></span>  <a class="code" href="frd_8h.html#a943bc52f706bd0462355f5dc74d210ceac207d63c32cf5df4f16d86d424eeaaad">USER_WENT_ONLINE</a> = 1, <span class="comment">///< Self went online</span></div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"><a class="line" href="frd_8h.html#a943bc52f706bd0462355f5dc74d210cead6309cdfe3bd67e4b93cf4e569ecde99"> 63</a></span>  <a class="code" href="frd_8h.html#a943bc52f706bd0462355f5dc74d210cead6309cdfe3bd67e4b93cf4e569ecde99">USER_WENT_OFFLINE</a>, <span class="comment">///< Self went offline</span></div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"><a class="line" href="frd_8h.html#a943bc52f706bd0462355f5dc74d210ceadb9362be5e6797b2713bdf79ae917f12"> 64</a></span>  <a class="code" href="frd_8h.html#a943bc52f706bd0462355f5dc74d210ceadb9362be5e6797b2713bdf79ae917f12">FRIEND_WENT_ONLINE</a>, <span class="comment">///< Friend Went Online </span></div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="frd_8h.html#a943bc52f706bd0462355f5dc74d210ceaf7ddef1f8c13f6b25212a93437950d7d"> 65</a></span>  <a class="code" href="frd_8h.html#a943bc52f706bd0462355f5dc74d210ceaf7ddef1f8c13f6b25212a93437950d7d">FRIEND_UPDATED_PRESENCE</a>, <span class="comment">///< Friend Presence changed</span></div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="frd_8h.html#a943bc52f706bd0462355f5dc74d210ceaf3308c826c2e15972dd1d636121278fc"> 66</a></span>  <a class="code" href="frd_8h.html#a943bc52f706bd0462355f5dc74d210ceaf3308c826c2e15972dd1d636121278fc">FRIEND_UPDATED_MII</a>, <span class="comment">///< Friend Mii changed</span></div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="frd_8h.html#a943bc52f706bd0462355f5dc74d210cea90345854715456864c94b5ab4d694902"> 67</a></span>  <a class="code" href="frd_8h.html#a943bc52f706bd0462355f5dc74d210cea90345854715456864c94b5ab4d694902">FRIEND_UPDATED_PROFILE</a>, <span class="comment">///< Friend Profile changed</span></div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="frd_8h.html#a943bc52f706bd0462355f5dc74d210ceab26d06003a4f57acc59a3eeea44c253e"> 68</a></span>  <a class="code" href="frd_8h.html#a943bc52f706bd0462355f5dc74d210ceab26d06003a4f57acc59a3eeea44c253e">FRIEND_WENT_OFFLINE</a>, <span class="comment">///< Friend went offline</span></div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="frd_8h.html#a943bc52f706bd0462355f5dc74d210cea89f2fe1d7eb0972ad79d8b822b9387a8"> 69</a></span>  <a class="code" href="frd_8h.html#a943bc52f706bd0462355f5dc74d210cea89f2fe1d7eb0972ad79d8b822b9387a8">FRIEND_REGISTERED_USER</a>, <span class="comment">///< Friend registered self as friend</span></div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <a class="code" href="frd_8h.html#a943bc52f706bd0462355f5dc74d210cea581fc030260d6166264caf3cbe83da35">FRIEND_SENT_INVITATION</a> <span class="comment">///< Friend Sent invitation</span></div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="frd_8h.html#a943bc52f706bd0462355f5dc74d210cea581fc030260d6166264caf3cbe83da35"> 71</a></span> } <a class="code" href="frd_8h.html#a943bc52f706bd0462355f5dc74d210ce">NotificationTypes</a>;</div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment">/// Initializes FRD service.</span></div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="frd_8h.html#a8031a28577f6a422ed5d2fa5542bf46f"> 74</a></span> <span class="comment"></span><a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="frd_8h.html#a8031a28577f6a422ed5d2fa5542bf46f">frdInit</a>(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment">/// Exists FRD.</span></div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="frd_8h.html#a5ec99ca5562cfefeb51007695dd3ec1c"> 77</a></span> <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="frd_8h.html#a5ec99ca5562cfefeb51007695dd3ec1c">frdExit</a>(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment">/// Get FRD handle.</span></div>
|
|
<div class="line"><a name="l00080"></a><span class="lineno"><a class="line" href="frd_8h.html#abc80cefa94c228b0231211912e074041"> 80</a></span> <span class="comment"></span><a class="code" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> *<a class="code" href="frd_8h.html#abc80cefa94c228b0231211912e074041">frdGetSessionHandle</a>(<span class="keywordtype">void</span>);<span class="comment"></span></div>
|
|
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> * @brief Gets the login status of the current user.</span></div>
|
|
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> * @param state Pointer to write the current user's login status to.</span></div>
|
|
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00085"></a><span class="lineno"><a class="line" href="frd_8h.html#aa1f34be91ea44f0d37c2756f65323975"> 85</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="frd_8h.html#aa1f34be91ea44f0d37c2756f65323975">FRDU_HasLoggedIn</a>(<span class="keywordtype">bool</span> *state);</div>
|
|
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="comment"> * @brief Gets the online status of the current user.</span></div>
|
|
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span> <span class="comment"> * @param state Pointer to write the current user's online status to.</span></div>
|
|
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="frd_8h.html#aca6f294dad46e3355c891bbad9f681a0"> 91</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="frd_8h.html#aca6f294dad46e3355c891bbad9f681a0">FRDU_IsOnline</a>(<span class="keywordtype">bool</span> *state);</div>
|
|
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="comment">/// Logs out of Nintendo's friend server.</span></div>
|
|
<div class="line"><a name="l00094"></a><span class="lineno"><a class="line" href="frd_8h.html#ad285890ae24b20e4b1fbbf0016658388"> 94</a></span> <span class="comment"></span><a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="frd_8h.html#ad285890ae24b20e4b1fbbf0016658388">FRD_Logout</a>(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a name="l00095"></a><span class="lineno"> 95</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="comment"> * @brief Log in to Nintendo's friend server.</span></div>
|
|
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment"> * @param event Event to signal when Login is done.</span></div>
|
|
<div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00100"></a><span class="lineno"><a class="line" href="frd_8h.html#acb24d435465d9e70a3d11ef375cfdd38"> 100</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="frd_8h.html#acb24d435465d9e70a3d11ef375cfdd38">FRD_Login</a>(<a class="code" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> event);</div>
|
|
<div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00102"></a><span class="lineno"> 102</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00103"></a><span class="lineno"> 103</span> <span class="comment"> * @brief Gets the current user's friend key.</span></div>
|
|
<div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="comment"> * @param key Pointer to write the current user's friend key to.</span></div>
|
|
<div class="line"><a name="l00105"></a><span class="lineno"> 105</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00106"></a><span class="lineno"><a class="line" href="frd_8h.html#ac8b838a00088afb5a5917ea67672afe2"> 106</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="frd_8h.html#ac8b838a00088afb5a5917ea67672afe2">FRD_GetMyFriendKey</a>(<a class="code" href="structFriendKey.html">FriendKey</a> *key);</div>
|
|
<div class="line"><a name="l00107"></a><span class="lineno"> 107</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00108"></a><span class="lineno"> 108</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment"> * @brief Gets the current user's privacy information.</span></div>
|
|
<div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="comment"> * @param isPublicMode Determines whether friends are notified of the current user's online status.</span></div>
|
|
<div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="comment"> * @param isShowGameName Determines whether friends are notified of the application that the current user is running.</span></div>
|
|
<div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> * @param isShowPlayedGame Determiens whether to display the current user's game history.</span></div>
|
|
<div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00114"></a><span class="lineno"><a class="line" href="frd_8h.html#a103bebd5c600bd4f071c1854ecc2a8b7"> 114</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="frd_8h.html#a103bebd5c600bd4f071c1854ecc2a8b7">FRD_GetMyPreference</a>(<span class="keywordtype">bool</span> *isPublicMode, <span class="keywordtype">bool</span> *isShowGameName, <span class="keywordtype">bool</span> *isShowPlayedGame);</div>
|
|
<div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> * @brief Gets the current user's profile information.</span></div>
|
|
<div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"> * @param profile Pointer to write the current user's profile information to.</span></div>
|
|
<div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00120"></a><span class="lineno"><a class="line" href="frd_8h.html#ae48da48556a2a63a9498131c3a0ba253"> 120</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="frd_8h.html#ae48da48556a2a63a9498131c3a0ba253">FRD_GetMyProfile</a>(<a class="code" href="structFriendProfile.html">FriendProfile</a> *profile);</div>
|
|
<div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00122"></a><span class="lineno"> 122</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00123"></a><span class="lineno"> 123</span> <span class="comment"> * @brief Gets the current user's screen name.</span></div>
|
|
<div class="line"><a name="l00124"></a><span class="lineno"> 124</span> <span class="comment"> * @param name Pointer to write the current user's screen name to.</span></div>
|
|
<div class="line"><a name="l00125"></a><span class="lineno"> 125</span> <span class="comment"> * @param max_size Max size of the screen name.</span></div>
|
|
<div class="line"><a name="l00126"></a><span class="lineno"> 126</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00127"></a><span class="lineno"><a class="line" href="frd_8h.html#a4f60c0b3b074a2199030632cab372cd9"> 127</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="frd_8h.html#a4f60c0b3b074a2199030632cab372cd9">FRD_GetMyScreenName</a>(<span class="keywordtype">char</span> *name, <span class="keywordtype">size_t</span> max_size);</div>
|
|
<div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00129"></a><span class="lineno"> 129</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="comment"> * @brief Gets the current user's Mii data.</span></div>
|
|
<div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment"> * @param mii Pointer to write the current user's mii data to.</span></div>
|
|
<div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00133"></a><span class="lineno"><a class="line" href="frd_8h.html#a2775b6e75e311a34e5d91cc2544b7f94"> 133</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="frd_8h.html#a2775b6e75e311a34e5d91cc2544b7f94">FRD_GetMyMii</a>(<a class="code" href="structMiiData.html">MiiData</a> *mii);</div>
|
|
<div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment"> * @brief Gets the current user's playing game.</span></div>
|
|
<div class="line"><a name="l00137"></a><span class="lineno"> 137</span> <span class="comment"> * @param titleId Pointer to write the current user's playing game to.</span></div>
|
|
<div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00139"></a><span class="lineno"><a class="line" href="frd_8h.html#a3e60ea2b614e06fc65be5400c1390e09"> 139</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="frd_8h.html#a3e60ea2b614e06fc65be5400c1390e09">FRD_GetMyPlayingGame</a>(<a class="code" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> *titleId);</div>
|
|
<div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"> * @brief Gets the current user's favourite game.</span></div>
|
|
<div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"> * @param titleId Pointer to write the title ID of current user's favourite game to.</span></div>
|
|
<div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00145"></a><span class="lineno"><a class="line" href="frd_8h.html#a0cfe1c6727abd4a744b40dd1b1c7ed65"> 145</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="frd_8h.html#a0cfe1c6727abd4a744b40dd1b1c7ed65">FRD_GetMyFavoriteGame</a>(<a class="code" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> *titleId);</div>
|
|
<div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00147"></a><span class="lineno"> 147</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="comment"> * @brief Gets the current user's comment on their friend profile.</span></div>
|
|
<div class="line"><a name="l00149"></a><span class="lineno"> 149</span> <span class="comment"> * @param comment Pointer to write the current user's comment to.</span></div>
|
|
<div class="line"><a name="l00150"></a><span class="lineno"> 150</span> <span class="comment"> * @param max_size Max size of the comment.</span></div>
|
|
<div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00152"></a><span class="lineno"><a class="line" href="frd_8h.html#a0c3a57f3610fec1186404ab3bc4ae3e7"> 152</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="frd_8h.html#a0c3a57f3610fec1186404ab3bc4ae3e7">FRD_GetMyComment</a>(<span class="keywordtype">char</span> *comment, <span class="keywordtype">size_t</span> max_size);</div>
|
|
<div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="comment"> * @brief Gets the current user's friend key list.</span></div>
|
|
<div class="line"><a name="l00156"></a><span class="lineno"> 156</span> <span class="comment"> * @param friendKeyList Pointer to write the friend key list to.</span></div>
|
|
<div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="comment"> * @param num Stores the number of friend keys obtained.</span></div>
|
|
<div class="line"><a name="l00158"></a><span class="lineno"> 158</span> <span class="comment"> * @param offset The index of the friend key to start with.</span></div>
|
|
<div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="comment"> * @param size Size of the friend key list. (FRIEND_LIST_SIZE)</span></div>
|
|
<div class="line"><a name="l00160"></a><span class="lineno"> 160</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00161"></a><span class="lineno"><a class="line" href="frd_8h.html#ad1e46d784e56d9d972edc0c49a0c82a5"> 161</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="frd_8h.html#ad1e46d784e56d9d972edc0c49a0c82a5">FRD_GetFriendKeyList</a>(<a class="code" href="structFriendKey.html">FriendKey</a> *friendKeyList, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *num, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> offset, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> size);</div>
|
|
<div class="line"><a name="l00162"></a><span class="lineno"> 162</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00163"></a><span class="lineno"> 163</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00164"></a><span class="lineno"> 164</span> <span class="comment"> * @brief Gets the current user's friends' Mii data.</span></div>
|
|
<div class="line"><a name="l00165"></a><span class="lineno"> 165</span> <span class="comment"> * @param miiDataList Pointer to write Mii data to.</span></div>
|
|
<div class="line"><a name="l00166"></a><span class="lineno"> 166</span> <span class="comment"> * @param friendKeyList Pointer to FriendKeys.</span></div>
|
|
<div class="line"><a name="l00167"></a><span class="lineno"> 167</span> <span class="comment"> * @param size Number of Friendkeys.</span></div>
|
|
<div class="line"><a name="l00168"></a><span class="lineno"> 168</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00169"></a><span class="lineno"><a class="line" href="frd_8h.html#a32a06db92c8333bc1210ac5b85e3f32d"> 169</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="frd_8h.html#a32a06db92c8333bc1210ac5b85e3f32d">FRD_GetFriendMii</a>(<a class="code" href="structMiiData.html">MiiData</a> *miiDataList, <span class="keyword">const</span> <a class="code" href="structFriendKey.html">FriendKey</a> *friendKeyList, <span class="keywordtype">size_t</span> size);</div>
|
|
<div class="line"><a name="l00170"></a><span class="lineno"> 170</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00171"></a><span class="lineno"> 171</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00172"></a><span class="lineno"> 172</span> <span class="comment"> * @brief Get the current user's friends' profile data.</span></div>
|
|
<div class="line"><a name="l00173"></a><span class="lineno"> 173</span> <span class="comment"> * @param profile Pointer to write profile data to.</span></div>
|
|
<div class="line"><a name="l00174"></a><span class="lineno"> 174</span> <span class="comment"> * @param friendKeyList Pointer to FriendKeys.</span></div>
|
|
<div class="line"><a name="l00175"></a><span class="lineno"> 175</span> <span class="comment"> * @param size Number of FriendKeys.</span></div>
|
|
<div class="line"><a name="l00176"></a><span class="lineno"> 176</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00177"></a><span class="lineno"><a class="line" href="frd_8h.html#ad387dd90a8b2fdc9fdfe6fd43e00cdc4"> 177</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="frd_8h.html#ad387dd90a8b2fdc9fdfe6fd43e00cdc4">FRD_GetFriendProfile</a>(<a class="code" href="structFriendProfile.html">FriendProfile</a> *profile, <span class="keyword">const</span> <a class="code" href="structFriendKey.html">FriendKey</a> *friendKeyList, <span class="keywordtype">size_t</span> size);</div>
|
|
<div class="line"><a name="l00178"></a><span class="lineno"> 178</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00179"></a><span class="lineno"> 179</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00180"></a><span class="lineno"> 180</span> <span class="comment"> * @brief Get the current user's friends' playing game.</span></div>
|
|
<div class="line"><a name="l00181"></a><span class="lineno"> 181</span> <span class="comment"> * @param desc Pointer to write Game Description data to.</span></div>
|
|
<div class="line"><a name="l00182"></a><span class="lineno"> 182</span> <span class="comment"> * @param friendKeyList Pointer to FriendKeys,</span></div>
|
|
<div class="line"><a name="l00183"></a><span class="lineno"> 183</span> <span class="comment"> * @param size Number Of FriendKeys.</span></div>
|
|
<div class="line"><a name="l00184"></a><span class="lineno"> 184</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00185"></a><span class="lineno"><a class="line" href="frd_8h.html#a721d99c1ec0709cdb5ab0a812cb6b2c9"> 185</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="frd_8h.html#a721d99c1ec0709cdb5ab0a812cb6b2c9">FRD_GetFriendPlayingGame</a>(<a class="code" href="structGameDescription.html">GameDescription</a> *desc, <span class="keyword">const</span> <a class="code" href="structFriendKey.html">FriendKey</a> *friendKeyList, <span class="keywordtype">size_t</span> size);</div>
|
|
<div class="line"><a name="l00186"></a><span class="lineno"> 186</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00187"></a><span class="lineno"> 187</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00188"></a><span class="lineno"> 188</span> <span class="comment"> * @brief Get the current user's friends' favourite game.</span></div>
|
|
<div class="line"><a name="l00189"></a><span class="lineno"> 189</span> <span class="comment"> * @param desc Pointer to write Game Description data to.</span></div>
|
|
<div class="line"><a name="l00190"></a><span class="lineno"> 190</span> <span class="comment"> * @param friendKeyList Pointer to FriendKeys,</span></div>
|
|
<div class="line"><a name="l00191"></a><span class="lineno"> 191</span> <span class="comment"> * @param count Number Of FriendKeys.</span></div>
|
|
<div class="line"><a name="l00192"></a><span class="lineno"> 192</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00193"></a><span class="lineno"><a class="line" href="frd_8h.html#a6f5acb955637da1b6a5ca75239889bb8"> 193</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="frd_8h.html#a6f5acb955637da1b6a5ca75239889bb8">FRD_GetFriendFavouriteGame</a>(<a class="code" href="structGameDescription.html">GameDescription</a> *desc, <span class="keyword">const</span> <a class="code" href="structFriendKey.html">FriendKey</a> *friendKeyList, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> count);</div>
|
|
<div class="line"><a name="l00194"></a><span class="lineno"> 194</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00195"></a><span class="lineno"> 195</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00196"></a><span class="lineno"> 196</span> <span class="comment"> * @brief Gets whether a friend key is included in the current user's friend list.</span></div>
|
|
<div class="line"><a name="l00197"></a><span class="lineno"> 197</span> <span class="comment"> * @param friendKeyList Pointer to a list of friend keys.</span></div>
|
|
<div class="line"><a name="l00198"></a><span class="lineno"> 198</span> <span class="comment"> * @param isFromList Pointer to a write the friendship status to.</span></div>
|
|
<div class="line"><a name="l00199"></a><span class="lineno"> 199</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00200"></a><span class="lineno"><a class="line" href="frd_8h.html#a40a567b07862845007f429263910db68"> 200</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="frd_8h.html#a40a567b07862845007f429263910db68">FRD_IsInFriendList</a>(<a class="code" href="structFriendKey.html">FriendKey</a> *friendKeyList, <span class="keywordtype">bool</span> *isFromList);</div>
|
|
<div class="line"><a name="l00201"></a><span class="lineno"> 201</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00202"></a><span class="lineno"> 202</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00203"></a><span class="lineno"> 203</span> <span class="comment"> * @brief Updates the game mode description string.</span></div>
|
|
<div class="line"><a name="l00204"></a><span class="lineno"> 204</span> <span class="comment"> * @param desc Pointer to write the game mode description to.</span></div>
|
|
<div class="line"><a name="l00205"></a><span class="lineno"> 205</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00206"></a><span class="lineno"><a class="line" href="frd_8h.html#a9f329cede46001a212236274b15349bf"> 206</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="frd_8h.html#a9f329cede46001a212236274b15349bf">FRD_UpdateGameModeDescription</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *desc);</div>
|
|
<div class="line"><a name="l00207"></a><span class="lineno"> 207</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00208"></a><span class="lineno"> 208</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00209"></a><span class="lineno"> 209</span> <span class="comment"> * @brief Event which is signaled when friend login states change.</span></div>
|
|
<div class="line"><a name="l00210"></a><span class="lineno"> 210</span> <span class="comment"> * @param event event which will be signaled.</span></div>
|
|
<div class="line"><a name="l00211"></a><span class="lineno"> 211</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00212"></a><span class="lineno"><a class="line" href="frd_8h.html#a6107bf9a0c2072b25fd4788ddbfeb8d6"> 212</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="frd_8h.html#a6107bf9a0c2072b25fd4788ddbfeb8d6">FRD_AttachToEventNotification</a>(<a class="code" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> event);</div>
|
|
<div class="line"><a name="l00213"></a><span class="lineno"> 213</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00214"></a><span class="lineno"> 214</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00215"></a><span class="lineno"> 215</span> <span class="comment"> * @brief Get Latest Event Notification</span></div>
|
|
<div class="line"><a name="l00216"></a><span class="lineno"> 216</span> <span class="comment"> * @param event Pointer to write recieved notification event struct to.</span></div>
|
|
<div class="line"><a name="l00217"></a><span class="lineno"> 217</span> <span class="comment"> * @param count Number of events</span></div>
|
|
<div class="line"><a name="l00218"></a><span class="lineno"> 218</span> <span class="comment"> * @param recievedNotifCount Number of notification reccieved.</span></div>
|
|
<div class="line"><a name="l00219"></a><span class="lineno"> 219</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00220"></a><span class="lineno"><a class="line" href="frd_8h.html#aadba819c10030b47f82ad4d6bcdece07"> 220</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="frd_8h.html#aadba819c10030b47f82ad4d6bcdece07">FRD_GetEventNotification</a>(<a class="code" href="structNotificationEvent.html">NotificationEvent</a> *event, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> count, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *recievedNotifCount); </div>
|
|
<div class="line"><a name="l00221"></a><span class="lineno"> 221</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00222"></a><span class="lineno"> 222</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00223"></a><span class="lineno"> 223</span> <span class="comment"> * @brief Returns the friend code using the given principal ID.</span></div>
|
|
<div class="line"><a name="l00224"></a><span class="lineno"> 224</span> <span class="comment"> * @param principalId The principal ID being used.</span></div>
|
|
<div class="line"><a name="l00225"></a><span class="lineno"> 225</span> <span class="comment"> * @param friendCode Pointer to write the friend code to.</span></div>
|
|
<div class="line"><a name="l00226"></a><span class="lineno"> 226</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00227"></a><span class="lineno"><a class="line" href="frd_8h.html#aa5ed0aecd7ff145f81a2009620d068a5"> 227</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="frd_8h.html#aa5ed0aecd7ff145f81a2009620d068a5">FRD_PrincipalIdToFriendCode</a>(<a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> principalId, <a class="code" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> *friendCode);</div>
|
|
<div class="line"><a name="l00228"></a><span class="lineno"> 228</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00229"></a><span class="lineno"> 229</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00230"></a><span class="lineno"> 230</span> <span class="comment"> * @brief Returns the principal ID using the given friend code.</span></div>
|
|
<div class="line"><a name="l00231"></a><span class="lineno"> 231</span> <span class="comment"> * @param friendCode The friend code being used.</span></div>
|
|
<div class="line"><a name="l00232"></a><span class="lineno"> 232</span> <span class="comment"> * @param principalId Pointer to write the principal ID to.</span></div>
|
|
<div class="line"><a name="l00233"></a><span class="lineno"> 233</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00234"></a><span class="lineno"><a class="line" href="frd_8h.html#aef38bc9bd2352ef69c11a1b74092487c"> 234</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="frd_8h.html#aef38bc9bd2352ef69c11a1b74092487c">FRD_FriendCodeToPrincipalId</a>(<a class="code" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> friendCode, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *principalId);</div>
|
|
<div class="line"><a name="l00235"></a><span class="lineno"> 235</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00236"></a><span class="lineno"> 236</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00237"></a><span class="lineno"> 237</span> <span class="comment"> * @brief Checks if the friend code is valid.</span></div>
|
|
<div class="line"><a name="l00238"></a><span class="lineno"> 238</span> <span class="comment"> * @param friendCode The friend code being used.</span></div>
|
|
<div class="line"><a name="l00239"></a><span class="lineno"> 239</span> <span class="comment"> * @param isValid Pointer to write the validity of the friend code to.</span></div>
|
|
<div class="line"><a name="l00240"></a><span class="lineno"> 240</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00241"></a><span class="lineno"><a class="line" href="frd_8h.html#a73759a0f468f63a1ed6871e88b84377c"> 241</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="frd_8h.html#a73759a0f468f63a1ed6871e88b84377c">FRD_IsValidFriendCode</a>(<a class="code" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> friendCode, <span class="keywordtype">bool</span> *isValid);</div>
|
|
<div class="line"><a name="l00242"></a><span class="lineno"> 242</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00243"></a><span class="lineno"> 243</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00244"></a><span class="lineno"> 244</span> <span class="comment"> * @brief Sets the Friend API to use a specific SDK version.</span></div>
|
|
<div class="line"><a name="l00245"></a><span class="lineno"> 245</span> <span class="comment"> * @param sdkVer The SDK version needed to be used.</span></div>
|
|
<div class="line"><a name="l00246"></a><span class="lineno"> 246</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00247"></a><span class="lineno"><a class="line" href="frd_8h.html#a910fe457d89b238b0fba46ce7c2340c3"> 247</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="frd_8h.html#a910fe457d89b238b0fba46ce7c2340c3">FRD_SetClientSdkVersion</a>(<a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> sdkVer);</div>
|
|
<div class="line"><a name="l00248"></a><span class="lineno"> 248</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00249"></a><span class="lineno"> 249</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00250"></a><span class="lineno"> 250</span> <span class="comment"> * @brief Add a Friend online.</span></div>
|
|
<div class="line"><a name="l00251"></a><span class="lineno"> 251</span> <span class="comment"> * @param event Event signaled when friend is registered.</span></div>
|
|
<div class="line"><a name="l00252"></a><span class="lineno"> 252</span> <span class="comment"> * @param principalId PrincipalId of the friend to add.</span></div>
|
|
<div class="line"><a name="l00253"></a><span class="lineno"> 253</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00254"></a><span class="lineno"><a class="line" href="frd_8h.html#a477f39a31ad43c2bc151e09ee1aa4ade"> 254</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="frd_8h.html#a477f39a31ad43c2bc151e09ee1aa4ade">FRD_AddFriendOnline</a>(<a class="code" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> event, <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> principalId);</div>
|
|
<div class="line"><a name="l00255"></a><span class="lineno"> 255</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00256"></a><span class="lineno"> 256</span> <span class="comment">/**</span></div>
|
|
<div class="line"><a name="l00257"></a><span class="lineno"> 257</span> <span class="comment"> * @brief Remove a Friend.</span></div>
|
|
<div class="line"><a name="l00258"></a><span class="lineno"> 258</span> <span class="comment"> * @param principalId PrinipalId of the friend code to remove.</span></div>
|
|
<div class="line"><a name="l00259"></a><span class="lineno"> 259</span> <span class="comment"> * @param localFriendCode LocalFriendCode of the friend code to remove.</span></div>
|
|
<div class="line"><a name="l00260"></a><span class="lineno"> 260</span> <span class="comment"> */</span></div>
|
|
<div class="line"><a name="l00261"></a><span class="lineno"><a class="line" href="frd_8h.html#a6cd1e48a71654365f11439e5f0b3f926"> 261</a></span> <a class="code" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> <a class="code" href="frd_8h.html#a6cd1e48a71654365f11439e5f0b3f926">FRD_RemoveFriend</a>(<a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> principalId, <a class="code" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> localFriendCode);</div>
|
|
<div class="ttc" id="afrd_8h_html_a0c3a57f3610fec1186404ab3bc4ae3e7"><div class="ttname"><a href="frd_8h.html#a0c3a57f3610fec1186404ab3bc4ae3e7">FRD_GetMyComment</a></div><div class="ttdeci">Result FRD_GetMyComment(char *comment, size_t max_size)</div><div class="ttdoc">Gets the current user's comment on their friend profile.</div></div>
|
|
<div class="ttc" id="afrd_8h_html_a0cfe1c6727abd4a744b40dd1b1c7ed65"><div class="ttname"><a href="frd_8h.html#a0cfe1c6727abd4a744b40dd1b1c7ed65">FRD_GetMyFavoriteGame</a></div><div class="ttdeci">Result FRD_GetMyFavoriteGame(u64 *titleId)</div><div class="ttdoc">Gets the current user's favourite game.</div></div>
|
|
<div class="ttc" id="afrd_8h_html_a103bebd5c600bd4f071c1854ecc2a8b7"><div class="ttname"><a href="frd_8h.html#a103bebd5c600bd4f071c1854ecc2a8b7">FRD_GetMyPreference</a></div><div class="ttdeci">Result FRD_GetMyPreference(bool *isPublicMode, bool *isShowGameName, bool *isShowPlayedGame)</div><div class="ttdoc">Gets the current user's privacy information.</div></div>
|
|
<div class="ttc" id="afrd_8h_html_a2775b6e75e311a34e5d91cc2544b7f94"><div class="ttname"><a href="frd_8h.html#a2775b6e75e311a34e5d91cc2544b7f94">FRD_GetMyMii</a></div><div class="ttdeci">Result FRD_GetMyMii(MiiData *mii)</div><div class="ttdoc">Gets the current user's Mii data.</div></div>
|
|
<div class="ttc" id="afrd_8h_html_a32a06db92c8333bc1210ac5b85e3f32d"><div class="ttname"><a href="frd_8h.html#a32a06db92c8333bc1210ac5b85e3f32d">FRD_GetFriendMii</a></div><div class="ttdeci">Result FRD_GetFriendMii(MiiData *miiDataList, const FriendKey *friendKeyList, size_t size)</div><div class="ttdoc">Gets the current user's friends' Mii data.</div></div>
|
|
<div class="ttc" id="afrd_8h_html_a3e60ea2b614e06fc65be5400c1390e09"><div class="ttname"><a href="frd_8h.html#a3e60ea2b614e06fc65be5400c1390e09">FRD_GetMyPlayingGame</a></div><div class="ttdeci">Result FRD_GetMyPlayingGame(u64 *titleId)</div><div class="ttdoc">Gets the current user's playing game.</div></div>
|
|
<div class="ttc" id="afrd_8h_html_a40a567b07862845007f429263910db68"><div class="ttname"><a href="frd_8h.html#a40a567b07862845007f429263910db68">FRD_IsInFriendList</a></div><div class="ttdeci">Result FRD_IsInFriendList(FriendKey *friendKeyList, bool *isFromList)</div><div class="ttdoc">Gets whether a friend key is included in the current user's friend list.</div></div>
|
|
<div class="ttc" id="afrd_8h_html_a477f39a31ad43c2bc151e09ee1aa4ade"><div class="ttname"><a href="frd_8h.html#a477f39a31ad43c2bc151e09ee1aa4ade">FRD_AddFriendOnline</a></div><div class="ttdeci">Result FRD_AddFriendOnline(Handle event, u32 principalId)</div><div class="ttdoc">Add a Friend online.</div></div>
|
|
<div class="ttc" id="afrd_8h_html_a4f60c0b3b074a2199030632cab372cd9"><div class="ttname"><a href="frd_8h.html#a4f60c0b3b074a2199030632cab372cd9">FRD_GetMyScreenName</a></div><div class="ttdeci">Result FRD_GetMyScreenName(char *name, size_t max_size)</div><div class="ttdoc">Gets the current user's screen name.</div></div>
|
|
<div class="ttc" id="afrd_8h_html_a5ec99ca5562cfefeb51007695dd3ec1c"><div class="ttname"><a href="frd_8h.html#a5ec99ca5562cfefeb51007695dd3ec1c">frdExit</a></div><div class="ttdeci">void frdExit(void)</div><div class="ttdoc">Exists FRD.</div></div>
|
|
<div class="ttc" id="afrd_8h_html_a6107bf9a0c2072b25fd4788ddbfeb8d6"><div class="ttname"><a href="frd_8h.html#a6107bf9a0c2072b25fd4788ddbfeb8d6">FRD_AttachToEventNotification</a></div><div class="ttdeci">Result FRD_AttachToEventNotification(Handle event)</div><div class="ttdoc">Event which is signaled when friend login states change.</div></div>
|
|
<div class="ttc" id="afrd_8h_html_a6cd1e48a71654365f11439e5f0b3f926"><div class="ttname"><a href="frd_8h.html#a6cd1e48a71654365f11439e5f0b3f926">FRD_RemoveFriend</a></div><div class="ttdeci">Result FRD_RemoveFriend(u32 principalId, u64 localFriendCode)</div><div class="ttdoc">Remove a Friend.</div></div>
|
|
<div class="ttc" id="afrd_8h_html_a6f5acb955637da1b6a5ca75239889bb8"><div class="ttname"><a href="frd_8h.html#a6f5acb955637da1b6a5ca75239889bb8">FRD_GetFriendFavouriteGame</a></div><div class="ttdeci">Result FRD_GetFriendFavouriteGame(GameDescription *desc, const FriendKey *friendKeyList, u32 count)</div><div class="ttdoc">Get the current user's friends' favourite game.</div></div>
|
|
<div class="ttc" id="afrd_8h_html_a721d99c1ec0709cdb5ab0a812cb6b2c9"><div class="ttname"><a href="frd_8h.html#a721d99c1ec0709cdb5ab0a812cb6b2c9">FRD_GetFriendPlayingGame</a></div><div class="ttdeci">Result FRD_GetFriendPlayingGame(GameDescription *desc, const FriendKey *friendKeyList, size_t size)</div><div class="ttdoc">Get the current user's friends' playing game.</div></div>
|
|
<div class="ttc" id="afrd_8h_html_a73759a0f468f63a1ed6871e88b84377c"><div class="ttname"><a href="frd_8h.html#a73759a0f468f63a1ed6871e88b84377c">FRD_IsValidFriendCode</a></div><div class="ttdeci">Result FRD_IsValidFriendCode(u64 friendCode, bool *isValid)</div><div class="ttdoc">Checks if the friend code is valid.</div></div>
|
|
<div class="ttc" id="afrd_8h_html_a8031a28577f6a422ed5d2fa5542bf46f"><div class="ttname"><a href="frd_8h.html#a8031a28577f6a422ed5d2fa5542bf46f">frdInit</a></div><div class="ttdeci">Result frdInit(void)</div><div class="ttdoc">Initializes FRD service.</div></div>
|
|
<div class="ttc" id="afrd_8h_html_a910fe457d89b238b0fba46ce7c2340c3"><div class="ttname"><a href="frd_8h.html#a910fe457d89b238b0fba46ce7c2340c3">FRD_SetClientSdkVersion</a></div><div class="ttdeci">Result FRD_SetClientSdkVersion(u32 sdkVer)</div><div class="ttdoc">Sets the Friend API to use a specific SDK version.</div></div>
|
|
<div class="ttc" id="afrd_8h_html_a943bc52f706bd0462355f5dc74d210ce"><div class="ttname"><a href="frd_8h.html#a943bc52f706bd0462355f5dc74d210ce">NotificationTypes</a></div><div class="ttdeci">NotificationTypes</div><div class="ttdoc">Enum to use with FRD_GetNotificationEvent.</div><div class="ttdef"><b>Definition:</b> frd.h:61</div></div>
|
|
<div class="ttc" id="afrd_8h_html_a943bc52f706bd0462355f5dc74d210cea581fc030260d6166264caf3cbe83da35"><div class="ttname"><a href="frd_8h.html#a943bc52f706bd0462355f5dc74d210cea581fc030260d6166264caf3cbe83da35">FRIEND_SENT_INVITATION</a></div><div class="ttdeci">@ FRIEND_SENT_INVITATION</div><div class="ttdoc">Friend Sent invitation.</div><div class="ttdef"><b>Definition:</b> frd.h:70</div></div>
|
|
<div class="ttc" id="afrd_8h_html_a943bc52f706bd0462355f5dc74d210cea89f2fe1d7eb0972ad79d8b822b9387a8"><div class="ttname"><a href="frd_8h.html#a943bc52f706bd0462355f5dc74d210cea89f2fe1d7eb0972ad79d8b822b9387a8">FRIEND_REGISTERED_USER</a></div><div class="ttdeci">@ FRIEND_REGISTERED_USER</div><div class="ttdoc">Friend registered self as friend.</div><div class="ttdef"><b>Definition:</b> frd.h:69</div></div>
|
|
<div class="ttc" id="afrd_8h_html_a943bc52f706bd0462355f5dc74d210cea90345854715456864c94b5ab4d694902"><div class="ttname"><a href="frd_8h.html#a943bc52f706bd0462355f5dc74d210cea90345854715456864c94b5ab4d694902">FRIEND_UPDATED_PROFILE</a></div><div class="ttdeci">@ FRIEND_UPDATED_PROFILE</div><div class="ttdoc">Friend Profile changed.</div><div class="ttdef"><b>Definition:</b> frd.h:67</div></div>
|
|
<div class="ttc" id="afrd_8h_html_a943bc52f706bd0462355f5dc74d210ceab26d06003a4f57acc59a3eeea44c253e"><div class="ttname"><a href="frd_8h.html#a943bc52f706bd0462355f5dc74d210ceab26d06003a4f57acc59a3eeea44c253e">FRIEND_WENT_OFFLINE</a></div><div class="ttdeci">@ FRIEND_WENT_OFFLINE</div><div class="ttdoc">Friend went offline.</div><div class="ttdef"><b>Definition:</b> frd.h:68</div></div>
|
|
<div class="ttc" id="afrd_8h_html_a943bc52f706bd0462355f5dc74d210ceac207d63c32cf5df4f16d86d424eeaaad"><div class="ttname"><a href="frd_8h.html#a943bc52f706bd0462355f5dc74d210ceac207d63c32cf5df4f16d86d424eeaaad">USER_WENT_ONLINE</a></div><div class="ttdeci">@ USER_WENT_ONLINE</div><div class="ttdoc">Self went online.</div><div class="ttdef"><b>Definition:</b> frd.h:62</div></div>
|
|
<div class="ttc" id="afrd_8h_html_a943bc52f706bd0462355f5dc74d210cead6309cdfe3bd67e4b93cf4e569ecde99"><div class="ttname"><a href="frd_8h.html#a943bc52f706bd0462355f5dc74d210cead6309cdfe3bd67e4b93cf4e569ecde99">USER_WENT_OFFLINE</a></div><div class="ttdeci">@ USER_WENT_OFFLINE</div><div class="ttdoc">Self went offline.</div><div class="ttdef"><b>Definition:</b> frd.h:63</div></div>
|
|
<div class="ttc" id="afrd_8h_html_a943bc52f706bd0462355f5dc74d210ceadb9362be5e6797b2713bdf79ae917f12"><div class="ttname"><a href="frd_8h.html#a943bc52f706bd0462355f5dc74d210ceadb9362be5e6797b2713bdf79ae917f12">FRIEND_WENT_ONLINE</a></div><div class="ttdeci">@ FRIEND_WENT_ONLINE</div><div class="ttdoc">Friend Went Online.</div><div class="ttdef"><b>Definition:</b> frd.h:64</div></div>
|
|
<div class="ttc" id="afrd_8h_html_a943bc52f706bd0462355f5dc74d210ceaf3308c826c2e15972dd1d636121278fc"><div class="ttname"><a href="frd_8h.html#a943bc52f706bd0462355f5dc74d210ceaf3308c826c2e15972dd1d636121278fc">FRIEND_UPDATED_MII</a></div><div class="ttdeci">@ FRIEND_UPDATED_MII</div><div class="ttdoc">Friend Mii changed.</div><div class="ttdef"><b>Definition:</b> frd.h:66</div></div>
|
|
<div class="ttc" id="afrd_8h_html_a943bc52f706bd0462355f5dc74d210ceaf7ddef1f8c13f6b25212a93437950d7d"><div class="ttname"><a href="frd_8h.html#a943bc52f706bd0462355f5dc74d210ceaf7ddef1f8c13f6b25212a93437950d7d">FRIEND_UPDATED_PRESENCE</a></div><div class="ttdeci">@ FRIEND_UPDATED_PRESENCE</div><div class="ttdoc">Friend Presence changed.</div><div class="ttdef"><b>Definition:</b> frd.h:65</div></div>
|
|
<div class="ttc" id="afrd_8h_html_a9f329cede46001a212236274b15349bf"><div class="ttname"><a href="frd_8h.html#a9f329cede46001a212236274b15349bf">FRD_UpdateGameModeDescription</a></div><div class="ttdeci">Result FRD_UpdateGameModeDescription(const char *desc)</div><div class="ttdoc">Updates the game mode description string.</div></div>
|
|
<div class="ttc" id="afrd_8h_html_aa1f34be91ea44f0d37c2756f65323975"><div class="ttname"><a href="frd_8h.html#aa1f34be91ea44f0d37c2756f65323975">FRDU_HasLoggedIn</a></div><div class="ttdeci">Result FRDU_HasLoggedIn(bool *state)</div><div class="ttdoc">Gets the login status of the current user.</div></div>
|
|
<div class="ttc" id="afrd_8h_html_aa5ed0aecd7ff145f81a2009620d068a5"><div class="ttname"><a href="frd_8h.html#aa5ed0aecd7ff145f81a2009620d068a5">FRD_PrincipalIdToFriendCode</a></div><div class="ttdeci">Result FRD_PrincipalIdToFriendCode(u32 principalId, u64 *friendCode)</div><div class="ttdoc">Returns the friend code using the given principal ID.</div></div>
|
|
<div class="ttc" id="afrd_8h_html_aadba819c10030b47f82ad4d6bcdece07"><div class="ttname"><a href="frd_8h.html#aadba819c10030b47f82ad4d6bcdece07">FRD_GetEventNotification</a></div><div class="ttdeci">Result FRD_GetEventNotification(NotificationEvent *event, u32 count, u32 *recievedNotifCount)</div><div class="ttdoc">Get Latest Event Notification.</div></div>
|
|
<div class="ttc" id="afrd_8h_html_abc80cefa94c228b0231211912e074041"><div class="ttname"><a href="frd_8h.html#abc80cefa94c228b0231211912e074041">frdGetSessionHandle</a></div><div class="ttdeci">Handle * frdGetSessionHandle(void)</div><div class="ttdoc">Get FRD handle.</div></div>
|
|
<div class="ttc" id="afrd_8h_html_ac8b838a00088afb5a5917ea67672afe2"><div class="ttname"><a href="frd_8h.html#ac8b838a00088afb5a5917ea67672afe2">FRD_GetMyFriendKey</a></div><div class="ttdeci">Result FRD_GetMyFriendKey(FriendKey *key)</div><div class="ttdoc">Gets the current user's friend key.</div></div>
|
|
<div class="ttc" id="afrd_8h_html_aca6f294dad46e3355c891bbad9f681a0"><div class="ttname"><a href="frd_8h.html#aca6f294dad46e3355c891bbad9f681a0">FRDU_IsOnline</a></div><div class="ttdeci">Result FRDU_IsOnline(bool *state)</div><div class="ttdoc">Gets the online status of the current user.</div></div>
|
|
<div class="ttc" id="afrd_8h_html_acb24d435465d9e70a3d11ef375cfdd38"><div class="ttname"><a href="frd_8h.html#acb24d435465d9e70a3d11ef375cfdd38">FRD_Login</a></div><div class="ttdeci">Result FRD_Login(Handle event)</div><div class="ttdoc">Log in to Nintendo's friend server.</div></div>
|
|
<div class="ttc" id="afrd_8h_html_ad1e46d784e56d9d972edc0c49a0c82a5"><div class="ttname"><a href="frd_8h.html#ad1e46d784e56d9d972edc0c49a0c82a5">FRD_GetFriendKeyList</a></div><div class="ttdeci">Result FRD_GetFriendKeyList(FriendKey *friendKeyList, u32 *num, u32 offset, u32 size)</div><div class="ttdoc">Gets the current user's friend key list.</div></div>
|
|
<div class="ttc" id="afrd_8h_html_ad285890ae24b20e4b1fbbf0016658388"><div class="ttname"><a href="frd_8h.html#ad285890ae24b20e4b1fbbf0016658388">FRD_Logout</a></div><div class="ttdeci">Result FRD_Logout(void)</div><div class="ttdoc">Logs out of Nintendo's friend server.</div></div>
|
|
<div class="ttc" id="afrd_8h_html_ad387dd90a8b2fdc9fdfe6fd43e00cdc4"><div class="ttname"><a href="frd_8h.html#ad387dd90a8b2fdc9fdfe6fd43e00cdc4">FRD_GetFriendProfile</a></div><div class="ttdeci">Result FRD_GetFriendProfile(FriendProfile *profile, const FriendKey *friendKeyList, size_t size)</div><div class="ttdoc">Get the current user's friends' profile data.</div></div>
|
|
<div class="ttc" id="afrd_8h_html_ae48da48556a2a63a9498131c3a0ba253"><div class="ttname"><a href="frd_8h.html#ae48da48556a2a63a9498131c3a0ba253">FRD_GetMyProfile</a></div><div class="ttdeci">Result FRD_GetMyProfile(FriendProfile *profile)</div><div class="ttdoc">Gets the current user's profile information.</div></div>
|
|
<div class="ttc" id="afrd_8h_html_aef38bc9bd2352ef69c11a1b74092487c"><div class="ttname"><a href="frd_8h.html#aef38bc9bd2352ef69c11a1b74092487c">FRD_FriendCodeToPrincipalId</a></div><div class="ttdeci">Result FRD_FriendCodeToPrincipalId(u64 friendCode, u32 *principalId)</div><div class="ttdoc">Returns the principal ID using the given friend code.</div></div>
|
|
<div class="ttc" id="amii_8h_html"><div class="ttname"><a href="mii_8h.html">mii.h</a></div><div class="ttdoc">Shared Mii struct.</div></div>
|
|
<div class="ttc" id="astructFriendKey_html"><div class="ttname"><a href="structFriendKey.html">FriendKey</a></div><div class="ttdoc">Friend key data.</div><div class="ttdef"><b>Definition:</b> frd.h:16</div></div>
|
|
<div class="ttc" id="astructFriendProfile_html"><div class="ttname"><a href="structFriendProfile.html">FriendProfile</a></div><div class="ttdoc">Friend profile data.</div><div class="ttdef"><b>Definition:</b> frd.h:32</div></div>
|
|
<div class="ttc" id="astructFriendProfile_html_a3ecaf8888bcc2c4d649c5a6c2b173f89"><div class="ttname"><a href="structFriendProfile.html#a3ecaf8888bcc2c4d649c5a6c2b173f89">FriendProfile::platform</a></div><div class="ttdeci">u8 platform</div><div class="ttdoc">Platform code.</div><div class="ttdef"><b>Definition:</b> frd.h:37</div></div>
|
|
<div class="ttc" id="astructFriendProfile_html_aa93f7353683eae976b64232206c49418"><div class="ttname"><a href="structFriendProfile.html#aa93f7353683eae976b64232206c49418">FriendProfile::region</a></div><div class="ttdeci">u8 region</div><div class="ttdoc">The region code for the hardware.</div><div class="ttdef"><b>Definition:</b> frd.h:33</div></div>
|
|
<div class="ttc" id="astructFriendProfile_html_abae6e8315e5692c6b0cb0e8702a3fcbb"><div class="ttname"><a href="structFriendProfile.html#abae6e8315e5692c6b0cb0e8702a3fcbb">FriendProfile::country</a></div><div class="ttdeci">u8 country</div><div class="ttdoc">Country code.</div><div class="ttdef"><b>Definition:</b> frd.h:34</div></div>
|
|
<div class="ttc" id="astructFriendProfile_html_abd435b314f8831ff5cf6161b7ea1fb0a"><div class="ttname"><a href="structFriendProfile.html#abd435b314f8831ff5cf6161b7ea1fb0a">FriendProfile::area</a></div><div class="ttdeci">u8 area</div><div class="ttdoc">Area code.</div><div class="ttdef"><b>Definition:</b> frd.h:35</div></div>
|
|
<div class="ttc" id="astructFriendProfile_html_acd0c5cfc685f6384f26c0d55bca0f611"><div class="ttname"><a href="structFriendProfile.html#acd0c5cfc685f6384f26c0d55bca0f611">FriendProfile::language</a></div><div class="ttdeci">u8 language</div><div class="ttdoc">Language code.</div><div class="ttdef"><b>Definition:</b> frd.h:36</div></div>
|
|
<div class="ttc" id="astructGameDescription_html"><div class="ttname"><a href="structGameDescription.html">GameDescription</a></div><div class="ttdoc">Game Description structure.</div><div class="ttdef"><b>Definition:</b> frd.h:43</div></div>
|
|
<div class="ttc" id="astructMiiData_html"><div class="ttname"><a href="structMiiData.html">MiiData</a></div><div class="ttdoc">Shared Mii struct.</div><div class="ttdef"><b>Definition:</b> mii.h:13</div></div>
|
|
<div class="ttc" id="astructNotificationEvent_html"><div class="ttname"><a href="structNotificationEvent.html">NotificationEvent</a></div><div class="ttdoc">Friend Notification Event structure.</div><div class="ttdef"><b>Definition:</b> frd.h:50</div></div>
|
|
<div class="ttc" id="astructTitleData_html"><div class="ttname"><a href="structTitleData.html">TitleData</a></div><div class="ttdoc">Friend Title data.</div><div class="ttdef"><b>Definition:</b> frd.h:24</div></div>
|
|
<div class="ttc" id="atypes_8h_html_a3f7e2bcbb0b4c338f3c4f6c937cd4234"><div class="ttname"><a href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a></div><div class="ttdeci">uint64_t u64</div><div class="ttdoc">64-bit unsigned integer</div><div class="ttdef"><b>Definition:</b> types.h:24</div></div>
|
|
<div class="ttc" id="atypes_8h_html_a92c50087ca0e64fa93fc59402c55f8ca"><div class="ttname"><a href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a></div><div class="ttdeci">uint8_t u8</div><div class="ttdoc">would be nice if newlib had this already</div><div class="ttdef"><b>Definition:</b> types.h:21</div></div>
|
|
<div class="ttc" id="atypes_8h_html_ab6d744c6b5de129f12937e482dc674fb"><div class="ttname"><a href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a></div><div class="ttdeci">u32 Handle</div><div class="ttdoc">Resource handle.</div><div class="ttdef"><b>Definition:</b> types.h:41</div></div>
|
|
<div class="ttc" id="atypes_8h_html_ac830bf5a4f2cf8273f61ab99a46cf163"><div class="ttname"><a href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a></div><div class="ttdeci">s32 Result</div><div class="ttdoc">Function result.</div><div class="ttdef"><b>Definition:</b> types.h:42</div></div>
|
|
<div class="ttc" id="atypes_8h_html_ace9d960e74685e2cd84b36132dbbf8aa"><div class="ttname"><a href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a></div><div class="ttdeci">uint16_t u16</div><div class="ttdoc">16-bit unsigned integer</div><div class="ttdef"><b>Definition:</b> types.h:22</div></div>
|
|
<div class="ttc" id="atypes_8h_html_afaa62991928fb9fb18ff0db62a040aba"><div class="ttname"><a href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a></div><div class="ttdeci">uint32_t u32</div><div class="ttdoc">32-bit unsigned integer</div><div class="ttdef"><b>Definition:</b> types.h:23</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <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>
|